Skip to main content
GET
/
sales-report
Retrieve Company Sales Report
curl --request GET \
  --url https://api.nuwebgroup.com/v1/sales-report \
  --header 'Authorization: Bearer <token>'
[
  {
    "currencySymbol": "Ā£",
    "today": {
      "cash": 200,
      "card": 300,
      "total": 500
    },
    "thisWeek": {
      "cash": 200,
      "card": 300,
      "total": 500
    },
    "allTime": {
      "cash": 200,
      "card": 300,
      "total": 500
    },
    "days": [
      {
        "date": "2021-01-01",
        "value": {
          "cash": 200,
          "card": 300,
          "total": 500
        }
      }
    ]
  }
]

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
shop_id
integer

When specified, only this epos shop's sales will be returned.

Response

Successfully retrieved the sales report.

ā€‹
currencySymbol
string
ā€‹
today
object
ā€‹
thisWeek
object
ā€‹
allTime
object
ā€‹
days
object[]
Example:
[
  {
    "currencySymbol": "Ā£",
    "today": { "cash": 200, "card": 300, "total": 500 },
    "thisWeek": { "cash": 200, "card": 300, "total": 500 },
    "allTime": { "cash": 200, "card": 300, "total": 500 },
    "days": [
      {
        "date": "2021-01-01",
        "value": { "cash": 200, "card": 300, "total": 500 }
      }
    ]
  }
]