List Cashier Sessions
Testing
GET
/v1/cashier-sessions/
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:
2
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/cashier-sessions/?startTimestamp=2024-03-27T19:00:00-06:00&endTimestamp=2024-03-28T19:00:00-06:00&pageSize=2&page=0&storeUUID=a2f09385-7f1b-436c-9baa-bb9cf1174c25&storeUUID=206b8416-c3c8-4053-9bdf-a11f3ddd7da1'Responses
🟢200OK
application/json
Body
pagination
object
required
next
null
required
previous
null
required
count
integer
required
current
integer
required
pageSize
integer
required
data
array [object {17}]
required
closingType
string
optional
uuid
string
optional
storeName
string
optional
sessionNumber
integer
optional
state
string
optional
startedAt
integer
optional
startedByUser
string
optional
finishedAt
integer
optional
finishedByUser
string
optional
cashMovements
object
optional
sessionByPaymentType
array [object {8}]
optional
sales
object
optional
orders
object
optional
discounts
array [object {4}]
optional
serviceCharges
array [object {4}]
optional
cancellations
array [object {3}]
optional
tips
array [object {4}]
optional
datetime
string
required
Example
{
"pagination": {
"next": null,
"previous": null,
"count": 1,
"current": 0,
"pageSize": 2
},
"data": [
{
"closingType": "DAILY_CLOSING",
"uuid": "df44b988-3523-40a1-8e58-7c4306e7dd0e",
"storeName": "Parrot Cafe",
"sessionNumber": 308,
"state": "CLOSED",
"startedAt": "2025-01-01T15:46:52Z",
"startedByUser": "412a1ebb-bec0-437f-913e-306d68e2f048",
"finishedAt": "2025-01-02T02:13:05Z",
"finishedByUser": "412a1ebb-bec0-437f-913e-306d68e2f048",
"cashMovements": {
"startingAmount": 0,
"deposits": 0,
"withdrawals": 0,
"expectedAmount": 3364,
"reportedAmount": 3402,
"differenceAmount": 38
},
"sessionByPaymentType": [
{
"name": "Efectivo",
"paymentType": "CASH",
"totalSales": 3364,
"expectedAmount": 3364,
"reportedAmount": 3402,
"differenceAmount": 38,
"exchangeRate": 1,
"currencyCode": "MXN"
},
{
"name": "Tarjeta Débito",
"paymentType": "DEBIT_CARD",
"totalSales": 1981,
"expectedAmount": 1981,
"reportedAmount": 1829,
"differenceAmount": -152,
"exchangeRate": 1,
"currencyCode": "MXN"
},
{
"name": "Tarjeta Crédito",
"paymentType": "CREDIT_CARD",
"totalSales": 726,
"expectedAmount": 726,
"reportedAmount": 878,
"differenceAmount": 152,
"exchangeRate": 1,
"currencyCode": "MXN"
}
],
"sales": {
"totalSales": 7041.6,
"totalSalesByProviders": {
"PARROT": 6071,
"UBER_EATS": 468,
"RAPPI": 456.4,
"DIDI_FOOD": 46.2
},
"totalSalesByPaymentType": [
{
"uuid": "3576d979-5753-4e88-b2ea-b5b7ce1a6b39",
"name": "Efectivo",
"paymentType": "CASH",
"totalSales": 3364,
"numSales": 0
},
{
"uuid": "1ba374f2-eb8b-407d-b5c3-fb7339ab8204",
"name": "Tarjeta Débito",
"paymentType": "DEBIT_CARD",
"totalSales": 1981,
"numSales": 0
},
{
"uuid": "67e98806-e226-490e-9287-d97eca8001e7",
"name": "Tarjeta Crédito",
"paymentType": "CREDIT_CARD",
"totalSales": 726,
"numSales": 0
},
{
"uuid": "1a08af53-5689-5c20-ac23-a9e9dccbd2a9",
"name": "UBER_EATS",
"paymentType": "THIRD_PARTY",
"totalSales": 468,
"numSales": 3
},
{
"uuid": "e7df21dc-7587-5b67-a8cd-6ed78d82b7d5",
"name": "RAPPI",
"paymentType": "THIRD_PARTY",
"totalSales": 456.4,
"numSales": 4
},
{
"uuid": "21d1de90-22f5-582d-b664-5a7d9218b029",
"name": "DIDI_FOOD",
"paymentType": "THIRD_PARTY",
"totalSales": 46.2,
"numSales": 1
}
],
"totalSalesByOrderType": [
{
"uuid": "4f34089b-df4f-5bf6-b78f-1d04df258347",
"name": "Delivery",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "12f2b84e-e45b-4464-b68f-97a51c0ae970",
"name": "Mostrador",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "ce9ebf78-2a96-53bf-a2a3-9712c56a169e",
"name": "Delivery Uber Eats",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "bfc9b6b6-6ade-5297-8b5f-3c47cecdd103",
"name": "Pick-Up Uber Eats",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "511ceb09-6373-5b53-848f-52a7961f530f",
"name": "Delivery Rappi",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "76a8fed3-6464-594f-b80a-7eb76b32dad9",
"name": "Pick-Up Rappi",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "6fc8b06f-9a50-59b1-96d8-690ae1552d46",
"name": "Delivery DiDi Food",
"totalSales": 0,
"numSales": 0
},
{
"uuid": "4a7d0f89-883b-5211-99b7-40ed578c1fc0",
"name": "Pick-Up DiDi Food",
"totalSales": 0,
"numSales": 0
}
],
"salesSummary": {
"store": {
"grossSales": 6312,
"discounts": 241,
"serviceCharges": 0,
"totalSales": 6071,
"netSales": 5233.62
},
"providers": {
"grossSales": 1120,
"discounts": 149.4,
"serviceCharges": 0,
"totalSales": 970.6,
"netSales": 836.72
}
}
},
"orders": {
"numOpenOrders": 0,
"numFinishedOrders": 106,
"numCanceledOrders": 0,
"ordersByProvider": [
{
"provider": "UBER_EATS",
"open": 0,
"finished": 2,
"forcedClose": 1,
"canceledByPos": 0,
"canceledByExternal": 0
},
{
"provider": "RAPPI",
"open": 0,
"finished": 4,
"forcedClose": 0,
"canceledByPos": 0,
"canceledByExternal": 0
},
{
"provider": "DIDI_FOOD",
"open": 0,
"finished": 1,
"forcedClose": 0,
"canceledByPos": 0,
"canceledByExternal": 0
}
]
},
"discounts": [
{
"provider": "PARROT",
"name": "Point of sale",
"discountsTotal": 241,
"numDiscounts": 2
},
{
"provider": "UBER_EATS",
"name": "Uber Eats",
"discountsTotal": 0,
"numDiscounts": 0
},
{
"provider": "RAPPI",
"name": "Rappi",
"discountsTotal": 69.6,
"numDiscounts": 2
},
{
"provider": "DIDI_FOOD",
"name": "DiDi Food",
"discountsTotal": 79.8,
"numDiscounts": 1
}
],
"serviceCharges": [
{
"name": "Delivery Uber Eats",
"value": 0,
"counter": 0,
"provider": "UBER_EATS"
},
{
"name": "Pick-Up Uber Eats",
"value": 0,
"counter": 0,
"provider": "UBER_EATS"
},
{
"name": "Delivery Rappi",
"value": 0,
"counter": 0,
"provider": "RAPPI"
},
{
"name": "Pick-Up Rappi",
"value": 0,
"counter": 0,
"provider": "RAPPI"
},
{
"name": "Delivery DiDi Food",
"value": 0,
"counter": 0,
"provider": "DIDI_FOOD"
},
{
"name": "Pick-Up DiDi Food",
"value": 0,
"counter": 0,
"provider": "DIDI_FOOD"
}
],
"cancellations": [
{
"provider": "PARROT",
"totalCancellations": 0,
"numCanceledOrders": 0
},
{
"provider": "UBER_EATS",
"totalCancellations": 0,
"numCanceledOrders": 0
},
{
"provider": "RAPPI",
"totalCancellations": 0,
"numCanceledOrders": 0
},
{
"provider": "DIDI_FOOD",
"totalCancellations": 0,
"numCanceledOrders": 0
}
],
"tips": [
{
"uuid": "3576d979-5753-4e88-b2ea-b5b7ce1a6b39",
"name": "Efectivo",
"paymentType": "CASH",
"total": 0
},
{
"uuid": "67e98806-e226-490e-9287-d97eca8001e7",
"name": "Tarjeta Crédito",
"paymentType": "CREDIT_CARD",
"total": 0
},
{
"uuid": "1ba374f2-eb8b-407d-b5c3-fb7339ab8204",
"name": "Tarjeta Débito",
"paymentType": "DEBIT_CARD",
"total": 0
},
{
"uuid": "300665fb-e613-557f-9724-62e3036c6a3d",
"name": "Pay Terminal",
"paymentType": "PAY",
"total": 0
}
]
}
],
"datetime": "2025-05-13T12:04:05-06:00"
}Modified at 2025-05-13 22:04:41