List Orders
GET
/v1/orders
Note: startTimestampandendTimestampmust be at most 48 hours apart.
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
startTimestamp
string
required
Example:
2024-03-27T19:00:00-06:00
endTimestamp
string
required
Example:
2024-03-28T19:00:00-06:00
pageSize
integer
optional
Example:
100
page
string
optional
Example:
0
storeUUID
array[string]
optional
Example:
["a2f09385-7f1b-436c-9baa-bb9cf1174c25","206b8416-c3c8-4053-9bdf-a11f3ddd7da1"]
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/orders?startTimestamp=2024-03-27T19:00:00-06:00&endTimestamp=2024-03-28T19:00:00-06:00&pageSize=100&page=0&storeUUID=a2f09385-7f1b-436c-9baa-bb9cf1174c25&storeUUID=206b8416-c3c8-4053-9bdf-a11f3ddd7da1'Responses
🟢200OK
application/json
Body
pagination
object
required
next
integer
required
previous
null
required
count
integer
required
data
array [object {24}]
required
orderDiscount
number | null
required
createdAt
integer
required
uuid
string
required
status
string
required
provider
string
required
storeUuid
string
required
storeName
string
required
providerOrderId
string | null
required
orderType
string
required
orderTypeNameUuid
string | null
required
orderTypeName
string | null
required
totalPrice
integer
required
total
integer | number
required
brandName
string
required
invoicingCode
string
required
invoicingExpiresAt
integer
required
totalDiscounts
integer | number
required
totalServiceCharges
integer
required
tableUuid
string
required
tableName
string
required
customersCount
integer
required
orderReference
string
required
totalTaxes
number
required
finishedAt
integer
required
datetime
string
required
Example
{
"pagination": {
"next": 1,
"previous": null,
"count": 23,
"current": 0,
"pageSize": 5
},
"data": [
{
"createdAt": "2025-01-01T16:11:56Z",
"uuid": "2c4cb280-6b50-4884-b4d5-67c545372292",
"status": "FINISHED",
"provider": "PARROT",
"storeUuid": "9c015c60-d3a5-4ed0-ab9f-e818eaa861b8",
"storeName": "Parrot Cafe",
"providerOrderId": null,
"orderType": "TAKE_OUT",
"orderTypeNameUuid": "12f2b84e-e45b-4464-b68f-97a51c0ae970",
"orderTypeName": "Mostrador",
"totalPrice": "152.00",
"total": "152.00",
"brandName": "Parrot Cafe",
"invoicingCode": "2C401012572292",
"invoicingExpiresAt": "2025-02-01T05:59:59Z",
"totalDiscounts": "0.00",
"orderDiscount": null,
"totalServiceCharges": "0.00",
"tableUuid": null,
"tableName": null,
"customersCount": 1,
"orderReference": "010125-P-0001",
"totalTaxes": "20.97",
"finishedAt": "2025-01-01T16:11:58Z",
"createdByUserUuid": "412a1ebb-bec0-437f-913e-306d68e2f048"
},
{
"createdAt": "2025-01-01T16:32:40Z",
"uuid": "dc18ac11-10e2-4a1c-adc3-83b25cf3be97",
"status": "FINISHED",
"provider": "PARROT",
"storeUuid": "9c015c60-d3a5-4ed0-ab9f-e818eaa861b8",
"storeName": "Parrot Cafe",
"providerOrderId": null,
"orderType": "TAKE_OUT",
"orderTypeNameUuid": "12f2b84e-e45b-4464-b68f-97a51c0ae970",
"orderTypeName": "Mostrador",
"totalPrice": "29.00",
"total": "29.00",
"brandName": "Parrot Cafe",
"invoicingCode": "DC10101253BE97",
"invoicingExpiresAt": "2025-02-01T05:59:59Z",
"totalDiscounts": "0.00",
"orderDiscount": null,
"totalServiceCharges": "0.00",
"tableUuid": null,
"tableName": null,
"customersCount": 1,
"orderReference": "010125-P-0002",
"totalTaxes": "4.00",
"finishedAt": "2025-01-01T16:32:42Z",
"createdByUserUuid": "412a1ebb-bec0-437f-913e-306d68e2f048"
},
{
"createdAt": "2025-01-01T16:40:23Z",
"uuid": "c2f44dbb-327c-47b2-b94d-02576389bc6d",
"status": "FINISHED",
"provider": "PARROT",
"storeUuid": "9c015c60-d3a5-4ed0-ab9f-e818eaa861b8",
"storeName": "Parrot Cafe",
"providerOrderId": null,
"orderType": "TAKE_OUT",
"orderTypeNameUuid": "12f2b84e-e45b-4464-b68f-97a51c0ae970",
"orderTypeName": "Mostrador",
"totalPrice": "42.00",
"total": "42.00",
"brandName": "Parrot Cafe",
"invoicingCode": "C2F0101259BC6D",
"invoicingExpiresAt": "2025-02-01T05:59:59Z",
"totalDiscounts": "0.00",
"orderDiscount": null,
"totalServiceCharges": "0.00",
"tableUuid": null,
"tableName": null,
"customersCount": 1,
"orderReference": "010125-P-0003",
"totalTaxes": "5.79",
"finishedAt": "2025-01-01T16:40:29Z",
"createdByUserUuid": "412a1ebb-bec0-437f-913e-306d68e2f048"
},
{
"createdAt": "2025-01-01T16:50:30Z",
"uuid": "03db3899-8b35-4e4d-bf3e-656f70b07429",
"status": "FINISHED",
"provider": "PARROT",
"storeUuid": "9c015c60-d3a5-4ed0-ab9f-e818eaa861b8",
"storeName": "Parrot Cafe",
"providerOrderId": null,
"orderType": "TAKE_OUT",
"orderTypeNameUuid": "12f2b84e-e45b-4464-b68f-97a51c0ae970",
"orderTypeName": "Mostrador",
"totalPrice": "15.00",
"total": "15.00",
"brandName": "Parrot Cafe",
"invoicingCode": "03D01012507429",
"invoicingExpiresAt": "2025-02-01T05:59:59Z",
"totalDiscounts": "0.00",
"orderDiscount": null,
"totalServiceCharges": "0.00",
"tableUuid": null,
"tableName": null,
"customersCount": 1,
"orderReference": "010125-P-0004",
"totalTaxes": "2.07",
"finishedAt": "2025-01-01T16:50:31Z",
"createdByUserUuid": "412a1ebb-bec0-437f-913e-306d68e2f048"
},
{
"createdAt": "2025-01-01T17:08:41Z",
"uuid": "5e34e5ff-5a42-4ea9-82cd-566393bb6cdf",
"status": "FINISHED",
"provider": "PARROT",
"storeUuid": "9c015c60-d3a5-4ed0-ab9f-e818eaa861b8",
"storeName": "Parrot Cafe",
"providerOrderId": null,
"orderType": "TAKE_OUT",
"orderTypeNameUuid": "12f2b84e-e45b-4464-b68f-97a51c0ae970",
"orderTypeName": "Mostrador",
"totalPrice": "39.00",
"total": "39.00",
"brandName": "Parrot Cafe",
"invoicingCode": "5E3010125B6CDF",
"invoicingExpiresAt": "2025-02-01T05:59:59Z",
"totalDiscounts": "0.00",
"orderDiscount": null,
"totalServiceCharges": "0.00",
"tableUuid": null,
"tableName": null,
"customersCount": 1,
"orderReference": "010125-P-0005",
"totalTaxes": "5.38",
"finishedAt": "2025-01-01T17:08:45Z",
"createdByUserUuid": "412a1ebb-bec0-437f-913e-306d68e2f048"
}
],
"datetime": "2025-05-12T14:44:18-06:00"
}Modified at 2025-07-01 15:49:23