Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Tills in Bulk

Create up to 50 tills in a single request.

post/v2/locations/tills

Headers

Authorizationstring
X-CAP-API-OAUTH-TOKENstring

Request body

codestring required

Unique till code. Lowercase letters, digits, periods, underscores, hyphens. Max 50 characters.

namestring required

Display name. Letters, digits, underscores, and spaces. Cannot equal root.

storeParentCodestring required

Code of the parent store. Must be an existing active store with locale configured.

descriptionstring

Free-text description.

isActiveboolean

Whether the till is active. Defaults to true.

isAdminboolean

Whether this till has admin privileges. Defaults to false.

isDefaultboolean

Whether this is the default till for the parent store. Defaults to false.

externalIdsobject

Key-value pairs of external identifiers. Max five entries. Keys and values must be non-blank and max 200 characters each.

customFieldsobject

Custom field key-value pairs. Keys must match custom fields configured for the org.

Response

All tills created successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.