Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Point of Sale
Orders

Get sales

Returns the summary of the sales

get/consumers/{consumer_id}/pos/sales

Path parameters

consumer_idstring uuid required

Query parameters

date_fromstring date required

Start date (inclusive) of the period to get sales from

date_tostring date required

End date (inclusive) of the period to get sales from

location_idstring nullable

Unique identifier of the location. If none passed, sales from all locations will be returned unless the location was selected by the end-user

Response

Successful Response

totalnumber required

Total amount including tax of the sales

tax_amountnumber required

Total amount of the taxes

Example response

{
  "total": 10,
  "tax_amount": 1,
  "taxes": [
    {
      "tax_id": "371ca583-d218-4900-b236-397532cf0e39"
    }
  ]
}