Till

Till

List tills

get
/tenants/{tenantUid}/stores/{storeUid}/tills

Lists all tills.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/tills
200

Example response

Create a new till

post
/tenants/{tenantUid}/stores/{storeUid}/tills

Creates a new till. Access required: STORE ADMIN

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body

Create a new till

barcodePrinterstringOptionalDeprecated

NOTE: This field is deprecated. Printers should be defined on the device

cashDrawerstringOptional
namestringRequired
paymentTerminalstring · enumOptionalPossible values:
receiptPrinterstringOptionalDeprecated

NOTE: This field is deprecated. Printers should be defined on the device

regularPrinterstringOptionalDeprecated

NOTE: This field is deprecated. Printers should be defined on the device

tillNumberintegerRequired
tillUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
post
/tenants/{tenantUid}/stores/{storeUid}/tills
200

Example response

Get till details

get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

Get details for a till.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}
200

Example response

Update till details

put
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

Updates details for a till. Access required: STORE ADMIN

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body

Update till

barcodePrinterstringOptionalDeprecated

NOTE: This field is deprecated. Printers should be defined on the device

cashDrawerstringOptional
namestringOptional
paymentTerminalstring · enumOptionalPossible values:
receiptPrinterstringOptionalDeprecated

NOTE: This field is deprecated. Printers should be defined on the device

regularPrinterstringOptionalDeprecated

NOTE: This field is deprecated. Printers should be defined on the device

tillNumberintegerOptional
Responses
200

Example response

application/json
put
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}
200

Example response

Delete a till

delete
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}

Deletes a till. Access required: STORE ADMIN

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
delete
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}
204

No Content

No content

Get cashdrawer status for a till

get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

Get cashdrawer status for the cashdrawer connect to the current till

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

Open cashdrawer

post
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

Open the cashdrawer for the current till

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

OK

No content

post
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer

No content

List all cash control reports

get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports

Get a cash report

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
sortBystringOptional

Defines which field the resource list is sorted by.

cashreportFromDatestring · dateOptional

Reference to a from-date.

cashreportToDatestring · dateOptional

Reference to a to-date.

Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports
200

Example response

Get a specific cash report

get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

Get cash control details

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
cashreportUidstringRequired

Reference to a cashreport.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

Update cash report

put
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}

The comment field can even be updated on a cashreport with status CLOSED. All other fields can only be set as long as status is not CLOSED.

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
cashreportUidstringRequired

Reference to a cashreport.

Pattern: ^[A-Za-z0-9-_]+
Body
commentstringOptional
bankDepositAmountintegerOptional
bankDepositReferencestringOptional
cashAmountintegerOptional

When till is opened this is the change amount, when closed this is the counted amount.

statusstring · enumOptionalPossible values:
Responses
200

Example response

application/json
put
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}
200

Example response

Withdraw or deposit cash at cashdrawer

post
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}/withdrawals

Withdraw or deposit cash at cashdrawer

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
cashreportUidstringRequired

Reference to a cashreport.

Pattern: ^[A-Za-z0-9-_]+
Body
amountintegerRequired
commentstringRequired
Responses
200

OK

No content

post
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}/withdrawals
200

OK

No content

Register a device on for a till

post
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device

Register a new device to a till. Access required: STORE ADMIN

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
deviceIdentifierstringRequired
Responses
200

OK

No content

post
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device
200

OK

No content

Remove a device from a till

delete
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device

Remove a device from a till. Access required: STORE ADMIN

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
delete
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device
200

Example response

Get till status details by tillUid

get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status

Get till status by using token information and storeUid from url

Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tillUidstringRequired

Reference to a till.

Pattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
get
/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status
200

Example response

Last updated