Get purchases - QShop API Documentation

Get purchases

curl --request GET \
  --url http://staging.qshop.ng/apiv2/5f439e2e64d89817e562a811/analytics

{
  "data": {
    "products": {
      "currentPage": 1,
      "data": [
        {
          "_id": "60b5098f3a9a2946cbb01c00",
          "costPrice": null,
          "name": "😲 ",
          "price": 2000,
          "sale_price": null,
          "stock": 20256
        },
        {
          "_id": "6097fa2cdfb7de16f1cc398f",
          "costPrice": null,
          "name": "Test prod",
          "price": 9000,
          "sale_price": 1200,
          "stock": 10
        },
        {
          "_id": "60aa6f6cb2d261083ec7591f",
          "costPrice": null,
          "name": "Test TAG",
          "price": 9000,
          "sale_price": 0,
          "stock": 10067
        }
      ],
      "next": 2,
      "noOfPages": 20,
      "prev": null,
      "totalRecord": 58
    },
    "topCustomers": {
      "currentPage": 1,
      "data": [
        {
          "__v": 0,
          "_id": "621771d3893b196f52e7a74b",
          "created_at": "2022-02-24T11:53:55.746Z",
          "fullName": null,
          "isClaimed": false,
          "numberOfOrders": 0,
          "orderTotal": 0,
          "roles": [
            {
              "__v": 0,
              "_id": "5e7e8830872c2c0f8c1c3fb3",
              "isAdmin": false,
              "isSuperAdmin": false,
              "key": "shopper",
              "name": "Shopper",
              "type": "customer"
            }
          ],
          "shop": {
            "_id": "5f439e2e64d89817e562a811",
            "domainActive": true,
            "domainName": "louisanm.com",
            "name": "Pet store worldwide",
            "slug": "pet-store",
            "url": "https://louisanm.com"
          },
          "suspended": false,
          "suspendedRoles": [],
          "telephone": null,
          "updated_at": "2022-02-24T11:53:55.746Z",
          "user": {
            "__v": 0,
            "_id": "621771d3893b196f52e7a74d",
            "address": {
              "_id": "637b7f55c98fabffa247d85b",
              "line_1": "nnn",
              "line_2": "nn",
              "state": "Adamawa",
              "state_id": "5ee6a281eea46308e8f84844"
            },
            "addresses": [
              {
                "_id": "6336e0efc00bb5ff34d3379a",
                "line_1": "nnn",
                "line_2": "nn",
                "state": "Adamawa",
                "stateData": "5ee6a281eea46308e8f84844",
                "state_id": "5ee6a281eea46308e8f84844"
              }
            ],
            "email": "[email protected]",
            "full_name": "Louisa girl",
            "isActivated": true,
            "last_access": "2022-02-24T12:30:41.560Z",
            "profiles": [
              "621771d3893b196f52e7a74b"
            ],
            "reg_date": "2022-02-24T11:53:55.750Z",
            "reset_pass": false,
            "shopCount": 0,
            "social": [],
            "suspended": false,
            "telephone": "+2348137064736",
            "test_user": false,
            "username": "louisaoge938",
            "whatsapp": "+2348137064736"
          }
        },
        {
          "__v": 0,
          "_id": "621771808eeb5f6e39ec7063",
          "created_at": "2022-02-24T11:52:32.607Z",
          "fullName": null,
          "isClaimed": false,
          "numberOfOrders": 0,
          "orderTotal": 0,
          "roles": [
            {
              "__v": 0,
              "_id": "5e7e8830872c2c0f8c1c3fb3",
              "isAdmin": false,
              "isSuperAdmin": false,
              "key": "shopper",
              "name": "Shopper",
              "type": "customer"
            }
          ],
          "shop": {
            "_id": "5f439e2e64d89817e562a811",
            "domainActive": true,
            "domainName": "louisanm.com",
            "name": "Pet store worldwide",
            "slug": "pet-store",
            "url": "https://louisanm.com"
          },
          "suspended": false,
          "suspendedRoles": [],
          "telephone": null,
          "updated_at": "2022-02-24T11:52:32.607Z"
        },
        {
          "__v": 0,
          "_id": "621771af4950ec6e68f85b57",
          "created_at": "2022-02-24T11:53:19.708Z",
          "fullName": null,
          "isClaimed": false,
          "numberOfOrders": 0,
          "orderTotal": 0,
          "roles": [
            {
              "__v": 0,
              "_id": "5e7e8830872c2c0f8c1c3fb3",
              "isAdmin": false,
              "isSuperAdmin": false,
              "key": "shopper",
              "name": "Shopper",
              "type": "customer"
            }
          ],
          "shop": {
            "_id": "5f439e2e64d89817e562a811",
            "domainActive": true,
            "domainName": "louisanm.com",
            "name": "Pet store worldwide",
            "slug": "pet-store",
            "url": "https://louisanm.com"
          },
          "suspended": false,
          "suspendedRoles": [],
          "telephone": null,
          "updated_at": "2022-02-24T11:53:19.708Z"
        }
      ],
      "next": 2,
      "noOfPages": 8,
      "prev": null,
      "totalRecord": 23
    }
  },
  "msg": "Revenue aggregation successful",
  "success": true
}

GET

5f439e2e64d89817e562a811

analytics

Get purchases

curl --request GET \
  --url http://staging.qshop.ng/apiv2/5f439e2e64d89817e562a811/analytics

{
  "data": {
    "products": {
      "currentPage": 1,
      "data": [
        {
          "_id": "60b5098f3a9a2946cbb01c00",
          "costPrice": null,
          "name": "😲 ",
          "price": 2000,
          "sale_price": null,
          "stock": 20256
        },
        {
          "_id": "6097fa2cdfb7de16f1cc398f",
          "costPrice": null,
          "name": "Test prod",
          "price": 9000,
          "sale_price": 1200,
          "stock": 10
        },
        {
          "_id": "60aa6f6cb2d261083ec7591f",
          "costPrice": null,
          "name": "Test TAG",
          "price": 9000,
          "sale_price": 0,
          "stock": 10067
        }
      ],
      "next": 2,
      "noOfPages": 20,
      "prev": null,
      "totalRecord": 58
    },
    "topCustomers": {
      "currentPage": 1,
      "data": [
        {
          "__v": 0,
          "_id": "621771d3893b196f52e7a74b",
          "created_at": "2022-02-24T11:53:55.746Z",
          "fullName": null,
          "isClaimed": false,
          "numberOfOrders": 0,
          "orderTotal": 0,
          "roles": [
            {
              "__v": 0,
              "_id": "5e7e8830872c2c0f8c1c3fb3",
              "isAdmin": false,
              "isSuperAdmin": false,
              "key": "shopper",
              "name": "Shopper",
              "type": "customer"
            }
          ],
          "shop": {
            "_id": "5f439e2e64d89817e562a811",
            "domainActive": true,
            "domainName": "louisanm.com",
            "name": "Pet store worldwide",
            "slug": "pet-store",
            "url": "https://louisanm.com"
          },
          "suspended": false,
          "suspendedRoles": [],
          "telephone": null,
          "updated_at": "2022-02-24T11:53:55.746Z",
          "user": {
            "__v": 0,
            "_id": "621771d3893b196f52e7a74d",
            "address": {
              "_id": "637b7f55c98fabffa247d85b",
              "line_1": "nnn",
              "line_2": "nn",
              "state": "Adamawa",
              "state_id": "5ee6a281eea46308e8f84844"
            },
            "addresses": [
              {
                "_id": "6336e0efc00bb5ff34d3379a",
                "line_1": "nnn",
                "line_2": "nn",
                "state": "Adamawa",
                "stateData": "5ee6a281eea46308e8f84844",
                "state_id": "5ee6a281eea46308e8f84844"
              }
            ],
            "email": "[email protected]",
            "full_name": "Louisa girl",
            "isActivated": true,
            "last_access": "2022-02-24T12:30:41.560Z",
            "profiles": [
              "621771d3893b196f52e7a74b"
            ],
            "reg_date": "2022-02-24T11:53:55.750Z",
            "reset_pass": false,
            "shopCount": 0,
            "social": [],
            "suspended": false,
            "telephone": "+2348137064736",
            "test_user": false,
            "username": "louisaoge938",
            "whatsapp": "+2348137064736"
          }
        },
        {
          "__v": 0,
          "_id": "621771808eeb5f6e39ec7063",
          "created_at": "2022-02-24T11:52:32.607Z",
          "fullName": null,
          "isClaimed": false,
          "numberOfOrders": 0,
          "orderTotal": 0,
          "roles": [
            {
              "__v": 0,
              "_id": "5e7e8830872c2c0f8c1c3fb3",
              "isAdmin": false,
              "isSuperAdmin": false,
              "key": "shopper",
              "name": "Shopper",
              "type": "customer"
            }
          ],
          "shop": {
            "_id": "5f439e2e64d89817e562a811",
            "domainActive": true,
            "domainName": "louisanm.com",
            "name": "Pet store worldwide",
            "slug": "pet-store",
            "url": "https://louisanm.com"
          },
          "suspended": false,
          "suspendedRoles": [],
          "telephone": null,
          "updated_at": "2022-02-24T11:52:32.607Z"
        },
        {
          "__v": 0,
          "_id": "621771af4950ec6e68f85b57",
          "created_at": "2022-02-24T11:53:19.708Z",
          "fullName": null,
          "isClaimed": false,
          "numberOfOrders": 0,
          "orderTotal": 0,
          "roles": [
            {
              "__v": 0,
              "_id": "5e7e8830872c2c0f8c1c3fb3",
              "isAdmin": false,
              "isSuperAdmin": false,
              "key": "shopper",
              "name": "Shopper",
              "type": "customer"
            }
          ],
          "shop": {
            "_id": "5f439e2e64d89817e562a811",
            "domainActive": true,
            "domainName": "louisanm.com",
            "name": "Pet store worldwide",
            "slug": "pet-store",
            "url": "https://louisanm.com"
          },
          "suspended": false,
          "suspendedRoles": [],
          "telephone": null,
          "updated_at": "2022-02-24T11:53:19.708Z"
        }
      ],
      "next": 2,
      "noOfPages": 8,
      "prev": null,
      "totalRecord": 23
    }
  },
  "msg": "Revenue aggregation successful",
  "success": true
}

Query Parameters

startDate

string

Example:

"2022-02-01"

endDate

string

Example:

"2022-03-01"

limit

string

Example:

"3"

type

string

Example:

"purchases"

Response

200 - application/json

200

data

object

Show child attributes

data.products

object

Show child attributes

data.products.currentPage

number

Example:

1

data.products.data

object[]

Show child attributes

data.products.data._id

string

Example:

"60b5098f3a9a2946cbb01c00"

data.products.data.costPrice

unknown

data.products.data.name

string

Example:

"😲 "

data.products.data.price

number

Example:

2000

data.products.data.sale_price

number | null

Example:

null

data.products.data.stock

number

Example:

20256

Example:

[
  {
    "_id": "60b5098f3a9a2946cbb01c00",
    "costPrice": null,
    "name": "😲 ",
    "price": 2000,
    "sale_price": null,
    "stock": 20256
  },
  {
    "_id": "6097fa2cdfb7de16f1cc398f",
    "costPrice": null,
    "name": "Test prod",
    "price": 9000,
    "sale_price": 1200,
    "stock": 10
  },
  {
    "_id": "60aa6f6cb2d261083ec7591f",
    "costPrice": null,
    "name": "Test TAG",
    "price": 9000,
    "sale_price": 0,
    "stock": 10067
  }
]

data.products.next

number

Example:

2

data.products.noOfPages

number

Example:

20

data.products.prev

unknown

data.products.totalRecord

number

Example:

58

data.topCustomers

object

Show child attributes

data.topCustomers.currentPage

number

Example:

1

data.topCustomers.data

object[]

Show child attributes

data.topCustomers.data.__v

number

Example:

0

data.topCustomers.data._id

string

Example:

"621771d3893b196f52e7a74b"

data.topCustomers.data.created_at

string

Example:

"2022-02-24T11:53:55.746Z"

data.topCustomers.data.fullName

unknown

data.topCustomers.data.isClaimed

boolean

Example:

false

data.topCustomers.data.numberOfOrders

number

Example:

0

data.topCustomers.data.orderTotal

number

Example:

0

data.topCustomers.data.roles

object[]

Show child attributes

data.topCustomers.data.roles.__v

number

Example:

0

data.topCustomers.data.roles._id

string

Example:

"5e7e8830872c2c0f8c1c3fb3"

data.topCustomers.data.roles.isAdmin

boolean

Example:

false

data.topCustomers.data.roles.isSuperAdmin

boolean

Example:

false

data.topCustomers.data.roles.key

string

Example:

"shopper"

data.topCustomers.data.roles.name

string

Example:

"Shopper"

data.topCustomers.data.roles.type

string

Example:

"customer"

Example:

[
  {
    "__v": 0,
    "_id": "5e7e8830872c2c0f8c1c3fb3",
    "isAdmin": false,
    "isSuperAdmin": false,
    "key": "shopper",
    "name": "Shopper",
    "type": "customer"
  }
]

data.topCustomers.data.shop

object

Show child attributes

data.topCustomers.data.shop._id

string

Example:

"5f439e2e64d89817e562a811"

data.topCustomers.data.shop.domainActive

boolean

Example:

true

data.topCustomers.data.shop.domainName

string

Example:

"louisanm.com"

data.topCustomers.data.shop.name

string

Example:

"Pet store worldwide"

data.topCustomers.data.shop.slug

string

Example:

"pet-store"

data.topCustomers.data.shop.url

string

Example:

"https://louisanm.com"

data.topCustomers.data.suspended

boolean

Example:

false

data.topCustomers.data.suspendedRoles

any[]

Example:

[]

data.topCustomers.data.telephone

unknown

data.topCustomers.data.updated_at

string

Example:

"2022-02-24T11:53:55.746Z"

data.topCustomers.data.user

object

Show child attributes

data.topCustomers.data.user.__v

number

Example:

0

data.topCustomers.data.user._id

string

Example:

"621771d3893b196f52e7a74d"

data.topCustomers.data.user.address

object

Show child attributes

data.topCustomers.data.user.address._id

string

Example:

"637b7f55c98fabffa247d85b"

data.topCustomers.data.user.address.line_1

string

Example:

"nnn"

data.topCustomers.data.user.address.line_2

string

Example:

"nn"

data.topCustomers.data.user.address.state

string

Example:

"Adamawa"

data.topCustomers.data.user.address.state_id

string

Example:

"5ee6a281eea46308e8f84844"

data.topCustomers.data.user.addresses

object[]

Show child attributes

data.topCustomers.data.user.addresses._id

string

Example:

"6336e0efc00bb5ff34d3379a"

data.topCustomers.data.user.addresses.line_1

string

Example:

"nnn"

data.topCustomers.data.user.addresses.line_2

string

Example:

"nn"

data.topCustomers.data.user.addresses.state

string

Example:

"Adamawa"

data.topCustomers.data.user.addresses.stateData

string

Example:

"5ee6a281eea46308e8f84844"

data.topCustomers.data.user.addresses.state_id

string

Example:

"5ee6a281eea46308e8f84844"

Example:

[
  {
    "_id": "6336e0efc00bb5ff34d3379a",
    "line_1": "nnn",
    "line_2": "nn",
    "state": "Adamawa",
    "stateData": "5ee6a281eea46308e8f84844",
    "state_id": "5ee6a281eea46308e8f84844"
  }
]

data.topCustomers.data.user.email

string

Example:

"[email protected]"

data.topCustomers.data.user.full_name

string

Example:

"Louisa girl"

data.topCustomers.data.user.isActivated

boolean

Example:

true

data.topCustomers.data.user.last_access

string

Example:

"2022-02-24T12:30:41.560Z"

data.topCustomers.data.user.profiles

string[]

Example:

["621771d3893b196f52e7a74b"]

data.topCustomers.data.user.reg_date

string

Example:

"2022-02-24T11:53:55.750Z"

data.topCustomers.data.user.reset_pass

boolean

Example:

false

data.topCustomers.data.user.shopCount

number

Example:

0

Example:

[]

data.topCustomers.data.user.suspended

boolean

Example:

false

data.topCustomers.data.user.telephone

string

Example:

"+2348137064736"

data.topCustomers.data.user.test_user

boolean

Example:

false

data.topCustomers.data.user.username

string

Example:

"louisaoge938"

data.topCustomers.data.user.whatsapp

string

Example:

"+2348137064736"

Example:

[
  {
    "__v": 0,
    "_id": "621771d3893b196f52e7a74b",
    "created_at": "2022-02-24T11:53:55.746Z",
    "fullName": null,
    "isClaimed": false,
    "numberOfOrders": 0,
    "orderTotal": 0,
    "roles": [
      {
        "__v": 0,
        "_id": "5e7e8830872c2c0f8c1c3fb3",
        "isAdmin": false,
        "isSuperAdmin": false,
        "key": "shopper",
        "name": "Shopper",
        "type": "customer"
      }
    ],
    "shop": {
      "_id": "5f439e2e64d89817e562a811",
      "domainActive": true,
      "domainName": "louisanm.com",
      "name": "Pet store worldwide",
      "slug": "pet-store",
      "url": "https://louisanm.com"
    },
    "suspended": false,
    "suspendedRoles": [],
    "telephone": null,
    "updated_at": "2022-02-24T11:53:55.746Z",
    "user": {
      "__v": 0,
      "_id": "621771d3893b196f52e7a74d",
      "address": {
        "_id": "637b7f55c98fabffa247d85b",
        "line_1": "nnn",
        "line_2": "nn",
        "state": "Adamawa",
        "state_id": "5ee6a281eea46308e8f84844"
      },
      "addresses": [
        {
          "_id": "6336e0efc00bb5ff34d3379a",
          "line_1": "nnn",
          "line_2": "nn",
          "state": "Adamawa",
          "stateData": "5ee6a281eea46308e8f84844",
          "state_id": "5ee6a281eea46308e8f84844"
        }
      ],
      "email": "[email protected]",
      "full_name": "Louisa girl",
      "isActivated": true,
      "last_access": "2022-02-24T12:30:41.560Z",
      "profiles": ["621771d3893b196f52e7a74b"],
      "reg_date": "2022-02-24T11:53:55.750Z",
      "reset_pass": false,
      "shopCount": 0,
      "social": [],
      "suspended": false,
      "telephone": "+2348137064736",
      "test_user": false,
      "username": "louisaoge938",
      "whatsapp": "+2348137064736"
    }
  },
  {
    "__v": 0,
    "_id": "621771808eeb5f6e39ec7063",
    "created_at": "2022-02-24T11:52:32.607Z",
    "fullName": null,
    "isClaimed": false,
    "numberOfOrders": 0,
    "orderTotal": 0,
    "roles": [
      {
        "__v": 0,
        "_id": "5e7e8830872c2c0f8c1c3fb3",
        "isAdmin": false,
        "isSuperAdmin": false,
        "key": "shopper",
        "name": "Shopper",
        "type": "customer"
      }
    ],
    "shop": {
      "_id": "5f439e2e64d89817e562a811",
      "domainActive": true,
      "domainName": "louisanm.com",
      "name": "Pet store worldwide",
      "slug": "pet-store",
      "url": "https://louisanm.com"
    },
    "suspended": false,
    "suspendedRoles": [],
    "telephone": null,
    "updated_at": "2022-02-24T11:52:32.607Z"
  },
  {
    "__v": 0,
    "_id": "621771af4950ec6e68f85b57",
    "created_at": "2022-02-24T11:53:19.708Z",
    "fullName": null,
    "isClaimed": false,
    "numberOfOrders": 0,
    "orderTotal": 0,
    "roles": [
      {
        "__v": 0,
        "_id": "5e7e8830872c2c0f8c1c3fb3",
        "isAdmin": false,
        "isSuperAdmin": false,
        "key": "shopper",
        "name": "Shopper",
        "type": "customer"
      }
    ],
    "shop": {
      "_id": "5f439e2e64d89817e562a811",
      "domainActive": true,
      "domainName": "louisanm.com",
      "name": "Pet store worldwide",
      "slug": "pet-store",
      "url": "https://louisanm.com"
    },
    "suspended": false,
    "suspendedRoles": [],
    "telephone": null,
    "updated_at": "2022-02-24T11:53:19.708Z"
  }
]

data.topCustomers.next

number

Example:

2

data.topCustomers.noOfPages

number

Example:

8

data.topCustomers.prev

unknown

data.topCustomers.totalRecord

number

Example:

23

msg

string

Example:

"Revenue aggregation successful"

success

boolean

Example:

true

Get revenue User login

⌘I