Add Till

This API enables you to create a new Till for your store.


๐Ÿ‘

Note

API endpoint example

https://eu.api.capillarytech.com/v2/orgEntity/till

Prerequisites

  • Authentication; Basic or OAuth authentication details
  • Access group resource - Access to Organisation resource

Resource information

URIv2/orgEntity/till
HTTP methodPOST
Rate limitDefault
Batch supportNA

Request query/body parameters

Parameter
(Parameters marked with * are mandatory)
TypeDescription
name*stringName for the till. The Till name specified will be copied to Till code as well in the backend. You can have same till name and store names for tills and stores in different clusters.
password*stringPassword for the till
storeId*longStore ID of the parent Store to in which the Till has to be created.
descriptionstringDescription for the till.
billablebooleanSpecify if the till is used for billing. By default, the value is set as true.
storeServerIdlongStore server ID of the parent Store if available.
curl --location 'https://eu.api.capillarytech.com/v2/orgEntity/till' \
--header 'Authorization: Basic cmFuZG9tE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=' \
--header 'Content-Type: application/json' \
--data '{
  "description": "Testing description",
  "storeId": 50154731,
  "password": "123",
  "billable": true,
  "name": "new_till2239"
}'

Response parameters

ParameterDescription
createdIdThe till ID created.
warningsWarnings if any.
{
    "createdId": 50157065,
    "warnings": []
}

API-specific error codes

Error codeDescription
1207TIll name already exists. Use a unique name.
1214The parent store is not valid. Use a valid parent store ID
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!