Alpha API ReferenceShifts
Get shift report
Returns one row per shift in the date range with sales/void totals, payment-form breakdown, and manager/employees.
AuthorizationBearer <token>
In: header
Query Parameters
start*string
Format
date-timeend*string
Format
date-timesubsidiaryIds?array<string>
stockSiteIds?array<string>
targetCurrency?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/shifts/report?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"{
"accessRestricted": true,
"baseCurrency": "string",
"displayCurrency": "string",
"rows": [
{
"employees": [
{
"firstName": "string",
"id": "string",
"lastName": "string"
}
],
"end": "2019-08-24T14:15:22Z",
"manager": {
"firstName": "string",
"id": "string",
"lastName": "string"
},
"orderCount": 0,
"paymentFormBreakdown": {
"property1": 0.1,
"property2": 0.1
},
"salesTotal": 0.1,
"shiftId": "string",
"start": "2019-08-24T14:15:22Z",
"status": "PLANNED",
"stockSiteId": "string",
"subsidiaryId": "string",
"voidCount": 0,
"voidValue": 0.1
}
]
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}