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

You are viewing an old version of the API
Retrieve cash drawer shift

GET /v2/cash-drawers/shifts/{shift_id}

Provides the summary details for a single cash drawer shift.

See ListCashDrawerShiftEvents for a list of cash drawer shift events.


Permissions
CASH_DRAWER_READ
Guide
Retrieve a Cash Drawer Shift
Try in API Explorer
Name Description
shift_id
string

Required

The shift ID.

Name Description
location_id
string

Required

The ID of the location to retrieve cash drawer shifts from.

Response Fields

Name Description
cash_drawer_shift
CashDrawerShift

The cash drawer shift queried for.

errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/cash-drawers/shifts/{shift_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/cash-drawers/shifts/shift_id0 \
  -H 'Square-Version: 2021-05-13' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "cash_drawer_shift": {
    "id": "DCC99978-09A6-4926-849F-300BE9C5793A",
    "state": "CLOSED",
    "opened_at": "2019-11-22T00:42:54.000Z",
    "ended_at": "2019-11-22T00:44:49.000Z",
    "closed_at": "2019-11-22T00:44:49.000Z",
    "opening_employee_id": "",
    "ending_employee_id": "",
    "closing_employee_id": "",
    "description": "Misplaced some change",
    "opened_cash_money": {
      "amount": 10000,
      "currency": "USD"
    },
    "cash_payment_money": {
      "amount": 100,
      "currency": "USD"
    },
    "cash_refunds_money": {
      "amount": -100,
      "currency": "USD"
    },
    "cash_paid_in_money": {
      "amount": 10000,
      "currency": "USD"
    },
    "cash_paid_out_money": {
      "amount": -10000,
      "currency": "USD"
    },
    "expected_cash_money": {
      "amount": 10000,
      "currency": "USD"
    },
    "closed_cash_money": {
      "amount": 9970,
      "currency": "USD"
    },
    "device": {
      "name": "My iPad"
    }
  }
}

Share Feedback

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