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

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

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

Provides a paginated list of events for a single cash drawer shift.

Name Description
shift_id
string

Required

The shift ID.

Name Description
location_id
string

Required

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

limit
integer (32-bit)

Number of resources to be returned 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
events
CashDrawerShiftEvent [ ]

All of the events (payments, refunds, etc.) for a cash drawer during the shift.

cursor
string

Opaque cursor for fetching the next page. 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/{shift_id}/events
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/cash-drawers/shifts/shift_id0/events \
  -H 'Square-Version: 2021-05-13' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "events": [
    {
      "id": "9F07DB01-D85A-4B77-88C3-D5C64CEB5155",
      "event_type": "CASH_TENDER_PAYMENT",
      "event_money": {
        "amount": 100,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:02.000Z",
      "description": ""
    },
    {
      "id": "B2854CEA-A781-49B3-8F31-C64558231F48",
      "event_type": "CASH_TENDER_PAYMENT",
      "event_money": {
        "amount": 250,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:12.000Z",
      "description": ""
    },
    {
      "id": "B5FB7F72-95CD-44A3-974D-26C41064D042",
      "event_type": "CASH_TENDER_CANCELLED_PAYMENT",
      "event_money": {
        "amount": 250,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:23.000Z",
      "description": ""
    },
    {
      "id": "0B425480-8504-40B4-A867-37B23543931B",
      "event_type": "CASH_TENDER_REFUND",
      "event_money": {
        "amount": 100,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:43:46.000Z",
      "description": ""
    },
    {
      "id": "8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE",
      "event_type": "PAID_IN",
      "event_money": {
        "amount": 10000,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:44:18.000Z",
      "description": "Transfer from another drawer"
    },
    {
      "id": "D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F",
      "event_type": "PAID_OUT",
      "event_money": {
        "amount": 10000,
        "currency": "USD"
      },
      "created_at": "2019-11-22T00:44:29.000Z",
      "description": "Transfer out to another drawer"
    }
  ]
}

Share Feedback

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