• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the 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
Try in API Explorer
Name Description
location_id
string

Required

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

sort_order
string

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

begin_time
string

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

end_time
string

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

limit
integer

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

cursor
string

Opaque cursor for fetching the next page of results.

Response Fields

Name Description
items
CashDrawerShiftSummary [ ]

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

cursor
string

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

errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/cash-drawers/shifts
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/cash-drawers/shifts \
  -H 'Square-Version: 2020-09-23' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?