Use this API to update multiple existing stores in bulk. You can modify store details such as contact information, location coordinates, timezone, currency, language settings, and external IDs. The API processes stores in batches of 200 for optimal performance.

Example request

curl --location --request PUT 'https://eu.intouch.capillarytech.com/v2/orgEntity/store/bulk' \
--header 'X-CAP-API-OAUTH-TOKEN: eyJraWQiImFsZyI6IlJTMjU2In0.eyJpc3MiOiJDYXBpbGxhcnkiLCJleHAiOjE3NzUxNDgzNzUsImp0aSI6InhoZmYyd0M3NldLa3B4dW8xNGo5ZVEiLCJpYXQiOjE3NzUxNDQ3NzUsInN1YiI6Ik5lZXJhaiIsImNsaWVudF9pZCI6MjE5NzYsIm9yZ19pZCI6MTAwNzM3LCJ0b2tlbl91c2UiOiJ0b2tlbl9hY2Nlc3MiLCJjbGllbnRfa2V5IjoieHY0TFc3MXJOOXJyekY4NlcxMUx3M0pneiIsImRlZmF1bHRfdGlsbCI6NzUxNTUyODIsImhhc19wc2lfYWNjZXNzIjp0cnVlLCJzY29wZXMiOiJbXSJ9.bv2KjNQrsjy7_gCpbjq6GURfw1RDxIjXMYlT164lrN31Vnp3YJJrXwbM1yyOG-iStKAJuedyjBx7T3dua4ysos7L_UJg47Q0A-xbVA1R6Vqp3m2lPlX_pI8flBu5NdF2n3A3weCmXQj6Hyn2Rhbcs8il4lxCPPt3z7iRMzb66-d6GnpsuDodLfbUFF9j8GvVa2_Qq51xAjO13dcnkHdrtKFZrK5TCHgY-bBDMdW4A613d1tCzpfQo-5kiNSLwQjWDN6xQ-pcgXW5OU7SwIWhiKVApYJSFfBx6mNNsdBnculhgB-JwyXNwh8J7McBK8d-_t6RY-w_T_VA5YIhyNTwCA' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "id" : 75228794,
        "code": "thisisastore",
        "description": "This is a test store",
        "name": "ThisisAStore",
        "referenceId": -1,
        "email": "[email protected]",
        
        "landline": "080-99999999",
        "latitude": "13.0827",
        "longitude": "80.2707",
        "cityId": 2,
        "areaId": 2,
        "default": false,
        "externalIds": [
            "a1",
            "a2",
            "a3"
        ],
        "adminType": "GENERAL",
        "isActive": true,
        "parentConceptId": "75216471",
    "parentZoneId": "75152646"
    }
]'

Prerequisites

• Authentication: OAuth authentication
• Access group resource: Read and write access to the Store resource
• The stores being updated must already exist in the system (identified by store code)

Body parameters

Note: The Updatable column indicates whether a field can be changed after creation.
Fields marked No must still be supplied in the request body but will be ignored.

Field	Type	Required	Description	Updatable
id	integer	Optional	Unique ID of the store to be updated.	No
code	string	Required	Unique store code used to identify the store to update. The store must already exist in the system.	No
name	string	Required	Name of the store. Used for validation along with code.	No
description	string	Optional	Description of the store. Maximum 250 characters.	Yes
referenceId	integer	Optional	Reference ID of the store. Pass -1 if not applicable.	Yes
adminType	enum	Optional	Admin type of the store. Values: GENERAL, ADMIN.	Yes
isActive	boolean	Optional	Indicates whether the store is active.	Yes
isOuEnabled	boolean	Optional	Indicates whether the organisation unit (OU) is enabled for the store. Only applicable when the store is part of a concept hierarchy.	Yes
default	boolean	Optional	Indicates whether this is the default store.	Yes
parentConceptId	integer	Optional	ID of the parent concept the store belongs to.	Yes
parentZoneId	integer	Optional	ID of the parent zone the store belongs to.	Yes
timeZoneId	integer	Optional	Unique ID representing the timezone of the store's geographical location. Example: 191 for Asia/Kolkata.	Yes
currencyId	integer	Optional	Unique ID representing the base currency of the store's location. Example: 230 for Singapore Dollar, 211 for Australian Dollars.	Yes
languageId	integer	Optional	Unique ID representing the language used at the store. Example: 393.	Yes
externalIds	array	Optional	List of external identifiers associated with the store. Supports up to 3 external IDs.	Yes
email	string	Optional	Store's email address.	Yes
mobile	string	Optional	Store's mobile number.	Yes
landline	string	Optional	Store's landline number.	Yes
latitude	string	Optional	Latitude coordinate of the store.	Yes
longitude	string	Optional	Longitude coordinate of the store.	Yes
cityId	integer	Optional	Unique ID for the city where the store is located.	Yes
areaId	integer	Optional	Unique ID for the area where the store is located.	Yes

Example response

{
    "response": [
        {
            "entityId": 75228794,
            "result": {
                "id": 75228794,
                "code": "thisisastore",
                "description": "This is a test store",
                "name": "ThisisAStore",
                "type": "STORE",
                "referenceId": -1,
                "adminType": "GENERAL",
                "isActive": true,
                "parentZoneId": 75152646,
                "parentConceptId": 75216471,
                "externalIds": [
                    "a1",
                    "a2",
                    "a3"
                ],
                "email": "[email protected]",
                "landline": "080-99999999",
                "latitude": "13.0827",
                "longitude": "80.2707",
                "cityId": 2,
                "areaId": 2,
                "default": false
            },
            "errors": [],
            "warnings": []
        }
    ],
    "totalCount": 1,
    "failureCount": 0
}

Response parameters

Error & warning codes