post https://{host}/v2/orgEntity/till
This API enables you to create a new Till for your store.
Note
- You can also add custom fields to a till. The till level custom fields enables brands to add additional information about the till specially when the brand has multiple tills mapped to a store. For example, till code, till name, description about till etc. You can add a till with new custom fields, add a till with existing custom fields attached to it or can also add the custom fields while updating a till.
- For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call.
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
| URI | v2/orgEntity/till |
| HTTP method | POST |
| Rate limit | Default |
| Batch support | NA |
Request query/body parameters
| Parameter (Parameters marked with * are mandatory) |
Type | Description |
|---|---|---|
name* |
string |
Name 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* |
string |
Password for the till |
storeId* |
long |
Store ID of the parent Store to in which the Till has to be created. |
description |
string |
Description for the till. |
billable |
boolean |
Specify if the till is used for billing. By default, the value is set as true. |
storeServerId |
long |
Store 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
| Parameter | Description |
|---|---|
| createdId | The till ID created. |
| warnings | Warnings if any. |
{
"createdId": 50157065,
"warnings": []
}API-specific error codes
| Error code | Description |
|---|---|
| 1207 | TIll name already exists. Use a unique name. |
| 1214 | The parent store is not valid. Use a valid parent store ID |