Update Till with Custom Fields

put

https://{host}/v2/orgEntity/till/{id}

This API enables you to update a till and:

add existing custom fields to it
create new custom fields and add them to the till.
update existing custom fields associated with the till

👍
Note
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/{id}>

Prerequisites

Authentication: Basic or OAuth authentication details
Access group resource: Access to Organisation resource
Configuration:
If you want to create more than five custom fields, create a ticket to the sustenance team and increase the limit in the configuration PRODUCT_CONF_ORG_AUDITABLE_CUSTOM_FIELDS_LIMIT. By default, the maximum value is set as five.
If the configuration CONF_ALLOW_TILL_AUTH_FOR_ORG_ENTITY_CREATION is set to false, only admin tills can update custom fields. If a non-admin user attempts to update custom fields when this configuration is not enabled, the operation fails and returns error code 1209 ('Not an admin user'). When the configuration is enabled, any till can update custom fields.

Resource information


URI	v2/orgEntity/till/`{id}`
HTTP method	PUT
Rate limit	Default
Batch support	NA

Request path parameters

Parameter (Parameters marked with * are mandatory)	Type	Description
id*	Integer	Till Id of existing Till

Request body parameters

Parameter (Parameters marked with * are mandatory)	Type	Description
customFields*	array-obj	For addition of custom fields - Specify the custom fields to be added to the organization and attach them to the till, or specify the existing custom fields to be attached to the till. For more information on the definitions for the fields in the `customField` object, refer to the documentation on adding till with custom fields. For updating values of custom fields - Specify the updated value for the custom fields. Only values of the custom fields can be updated.

curl --location --request PUT 'https://eu.api.capillarytech.com/v2/orgEntity/till/50157006' \
--header 'type: ADMIN_USER' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cmFuZG9TE6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=' \
--data '{
    "customFields": [
    {
      "name": "cf_3",
      "type": "text",
      "dataType": "string",
      "label": "Custom Field Label",
      "defaultValue": "20",
      "phase": "",
      "position": 1,
      "rule": "",
      "serverRule": "",
      "regex": "",
      "error": "",
      "options": "",
      "isDisabled": 0,
      "isCompulsory": 0,
      "disableAtServer": 0,
      "isUpdatable": 1,
      "enableAuditTrail": 0,
      "isPiiData": 0,
      "isPsiData": 0,
      "helptext": "This is a custom field",
      "attrs": "",
      "value": "100"
    }
    ]
}'

curl --location --request PUT 'https://eu.api.capillarytech.com/v2/orgEntity/till/50157007' \
--header 'type: ADMIN_USER' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cmFuZG9tMTMjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=' \
--data '{
    "customFields": [
    {
      "name": "cf_1",
      "value": "1000"
    }
    ]
}'

curl --location --request PUT 'https://eu.api.capillarytech.com/v2/orgEntity/till/50157007' \
--header 'type: ADMIN_USER' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic cmFuZG9tMT6MjAyY2I5NjJhYzU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=' \
--data '{
    "customFields": [
    {
      "name": "cf_1",
      "value": "2000"
    }
    ]
}'

Response parameters

Parameterype	Type	Description
entity	String	The custom field ID created.
warnings	String	Warnings if any.

{
    "entity": 50157007,
    "warnings": [],
    "errors": [],
    "success": true
}

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
1209	Not an admin user. This error is returned if a non-admin user tries to update till custom fields when the configuration `CONF_ALLOW_TILL_AUTH_FOR_ORG_ENTITY_CREATION` is not enabled.
1023	The number of custom fields that can be created is reached. In the org settings, increase the limit of `PRODUCT_CONF_ORG_AUDITABLE_CUSTOM_FIELDS_LIMIT`. Default value: 5.
1024	The custom field parameter is null or empty. Enter a value for the parameter.
1025	There are multiple custom fields with the same name. Use a unique custom field name.

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!