CashDrawers
ListCashDrawerShifts
Provides the details for all of the cash drawer shifts for a location in a date range.
get/v2/cash-drawers/shifts
Query parameters
location_idstring required
The ID of the location to query for a list of cash drawer shifts.
sort_order'DESC' | 'ASC'
The order (e.g., chronological or alphabetical) in which results from a request are returned.
The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC
begin_timestring
The inclusive start time of the query on opened_at, in ISO 8601 format.
end_timestring
The exclusive end date of the query on opened_at, in ISO 8601 format.
limitinteger
Number of cash drawer shift events in a page of results (200 by default, 1000 max).
cursorstring
Opaque cursor for fetching the next page of results.
Response
Success
Example response
{
"cash_drawer_shifts": [
{
"closed_at": "2019-11-22T00:44:49.000Z",
"closed_cash_money": {
"amount": 9970,
"currency": "USD"
},
"description": "Misplaced some change",
"ended_at": "2019-11-22T00:44:49.000Z",
"expected_cash_money": {
"amount": 10000,
"currency": "USD"
},
"id": "DCC99978-09A6-4926-849F-300BE9C5793A",
"opened_at": "2019-11-22T00:42:54.000Z",
"opened_cash_money": {
"amount": 10000,
"currency": "USD"
},
"state": "CLOSED"
}
]
}