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

Link to section

Path parameters

Example code

Link to section

shift_id

string

Required

The shift ID.

Link to section

Query parameters

Link to section

location_id

string

Required

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

Link to section

Response fields

Link to section

cash_drawer_shift

The cash drawer shift queried for.

Link to section

errors

Any errors that occurred during the request.

Link to section

Examples

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

curl https://connect.squareup.com/v2/cash-drawers/shifts/shift_id0 \
  -H 'Square-Version: 2024-10-17' \
  -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_team_member_id": "",
    "ending_team_member_id": "",
    "closing_team_member_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"
    }
  }
}