Skip to content

Latest commit

 

History

History
179 lines (122 loc) · 6.42 KB

CashDrawersApi.md

File metadata and controls

179 lines (122 loc) · 6.42 KB
Raw

SquareConnect.CashDrawersApi

All URIs are relative to https://connect.squareup.com

Method HTTP request Description
listCashDrawerShiftEvents GET /v2/cash-drawers/shifts/{shift_id}/events ListCashDrawerShiftEvents
listCashDrawerShifts GET /v2/cash-drawers/shifts ListCashDrawerShifts
retrieveCashDrawerShift GET /v2/cash-drawers/shifts/{shift_id} RetrieveCashDrawerShift

listCashDrawerShiftEvents

ListCashDrawerShiftEventsResponse listCashDrawerShiftEvents(locationId, shiftId, opts)

ListCashDrawerShiftEvents

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

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.CashDrawersApi();

var locationId = "locationId_example"; // String | The ID of the location to list cash drawer shifts for.

var shiftId = "shiftId_example"; // String | The shift ID.

var opts = { 
  'limit': 56, // Number | Number of resources to be returned in a page of results (200 by default, 1000 max).
  'cursor': "cursor_example" // String | Opaque cursor for fetching the next page of results.
};
apiInstance.listCashDrawerShiftEvents(locationId, shiftId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
locationId String The ID of the location to list cash drawer shifts for.
shiftId String The shift ID.
limit Number Number of resources to be returned in a page of results (200 by default, 1000 max). [optional]
cursor String Opaque cursor for fetching the next page of results. [optional]

Return type

ListCashDrawerShiftEventsResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listCashDrawerShifts

ListCashDrawerShiftsResponse listCashDrawerShifts(locationId, opts)

ListCashDrawerShifts

Provides the details for all of the cash drawer shifts for a location in a date range.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.CashDrawersApi();

var locationId = "locationId_example"; // String | The ID of the location to query for a list of cash drawer shifts.

var opts = { 
  'sortOrder': "sortOrder_example", // String | The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC
  'beginTime': "beginTime_example", // String | The inclusive start time of the query on opened_at, in ISO 8601 format.
  'endTime': "endTime_example", // String | The exclusive end date of the query on opened_at, in ISO 8601 format.
  'limit': 56, // Number | Number of cash drawer shift events in a page of results (200 by default, 1000 max).
  'cursor': "cursor_example" // String | Opaque cursor for fetching the next page of results.
};
apiInstance.listCashDrawerShifts(locationId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
locationId String The ID of the location to query for a list of cash drawer shifts.
sortOrder String The order in which cash drawer shifts are listed in the response, based on their opened_at field. Default value: ASC [optional]
beginTime String The inclusive start time of the query on opened_at, in ISO 8601 format. [optional]
endTime String The exclusive end date of the query on opened_at, in ISO 8601 format. [optional]
limit Number Number of cash drawer shift events in a page of results (200 by default, 1000 max). [optional]
cursor String Opaque cursor for fetching the next page of results. [optional]

Return type

ListCashDrawerShiftsResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

retrieveCashDrawerShift

RetrieveCashDrawerShiftResponse retrieveCashDrawerShift(locationId, shiftId)

RetrieveCashDrawerShift

Provides the summary details for a single cash drawer shift. See RetrieveCashDrawerShiftEvents for a list of cash drawer shift events.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.CashDrawersApi();

var locationId = "locationId_example"; // String | The ID of the location to retrieve cash drawer shifts from.

var shiftId = "shiftId_example"; // String | The shift ID.

apiInstance.retrieveCashDrawerShift(locationId, shiftId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
locationId String The ID of the location to retrieve cash drawer shifts from.
shiftId String The shift ID.

Return type

RetrieveCashDrawerShiftResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json