The following information helps you migrate from the Connect v1 CashDrawer Shifts API code to the replacement Square API counterparts. For general guidance about the differences between Connect v1 and Square APIs, see the Connect v1 Migration guide.
On this page
The Connect v1 CashDrawer Shift API lets you create cash drawer shift reporting for cash drawer activity.
- Deprecation: 2020-02-26
- Retirement: 2021-02-26
If you need help migrating to Square APIs or need more time to complete your migration, contact Developer Support, join our Discord community, or reach out to your Square account manager.
The CashDrawer Shifts API provides all the functionality of the Connect v1 employees.CashDrawer Shift API and adds these features:
Pagination. The CashDrawer Shifts API reporting endpoints provide pagination and sorting along with location and time range filtering.
Cash drawer shift activity summary. The CashDrawerShiftSummary object is a cash drawer shift summary record that provides the following information:
- Shift start and end time
- Opening cash amount
- Expected closing cash amount
- Actual closing cash amount
Separate endpoint for events on a cash drawer shift. The Square ListCashDrawerShiftEvents endpoint provides reporting to get the events on a cash drawer shift by ID. The v1 CashDrawerShift object contains a collection of all the events on a cash drawer shift.
You can use the Square API endpoint to retrieve v1 CashDrawerShift data for reporting. You must make a separate API call to get the activity detail about a cash drawer shift.
Square CashDrawer Shifts API endpoints replace the v1 CashDrawerShift endpoints in the v1 Employees API.
You must update the code that relies on the following endpoints to avoid breaking when the v1 CashDrawer Shift API retires:
| v1 endpoint | Square replacement | Usage |
|---|---|---|
| ListCashDrawerShifts | Changed ListCashDrawerShifts | No longer returns a list of CashDrawerShift. Now returns a list of CashDrawerShiftSummary. |
| RetrieveCashDrawerShift | RetrieveCashDrawerShift | Gets a single CashDrawerShift with the details of a single cash drawer shift. |
| ListCashDrawerShifts | New ListCashDrawerShiftEvents | Returns a list of CashDrawerShiftEvent objects as the activity on a cash drawer shift. |
With a couple of exceptions, all fields in the V1CashDrawerShift object are available in Square CashDrawer Shifts API objects. As a result, most code only needs to update the endpoint reference and field names to work properly.
The Square API CashDrawerShift object contains all the fields of the v1 object with the following exceptions:
| v1 field | Square field | Notes |
|---|---|---|
event_type | state | state values are OPEN, CLOSED, and ENDED. |
starting_cash_money | opened_cash_money | |
device | device | New object type: CashDrawerShift.device is of type CashDrawerDevice. |
events | Removed | The events field is replaced by the list of CashDrawerShiftEvent. objects returned by ListCashDrawerShiftEvents. |
The Square API ListCashDrawerShiftsResponse object returns a different object type.
| v1 field | Square field | Notes |
|---|---|---|
items | items | New object type: items is of type CashDrawerShiftSummary. |
The Square API Money object expands the maximum value of the amount field.
| v1 field | Square field | Notes |
|---|---|---|
amount | amount | Changed type: amount is now a 64-bit int. |
currency_code | currency |