<- Cash Drawers API

Cash Drawers API

List cash drawer shifts

GET

 /v2/cash-drawers/shifts

Provides the details for all of the cash drawer shifts for a location in a date range.

Permissions:CASH_DRAWER_READ

Guide

List Cash Drawer Shifts

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

location_id

string

Required

The ID of the location to query for a list of cash drawer shifts.

Link to section

sort_order

string

The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC

Link to section

begin_time

string

The inclusive start time of the query on opened_at, in ISO 8601 format.

Link to section

end_time

string

The exclusive end date of the query on opened_at, in ISO 8601 format.

Link to section

limit

integer(32-bit)

Number of cash drawer shift events in a page of results (200 by default, 1000 max).

Link to section

cursor

string

Opaque cursor for fetching the next page of results.

Link to section

Response fields

Link to section

cursor

string

Opaque cursor for fetching the next page of results. Cursor is not present in the last page of results.

Link to section

errors

Any errors that occurred during the request.

Link to section

cash_drawer_shifts

A collection of CashDrawerShiftSummary objects for shifts that match the query.