post
https://{host}/v2/orgEntity/store
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
The API allows the organisation admin to add a store to an organisation. It supports custom fields used to store additional information related to the store.
Prerequisites
- Authentication: OAuth authentication
- Access group resource: Read and write access to the
Storeresource
Example request
curl --location 'https://eu.intouch.capillarytech.com/v2/orgEntity/store' \
--header 'Content-Type: application/json' \
--header 'X-CAP-API-OAUTH-TOKEN: eyJraWQiOiJrMSIsImFsLnUORZxL6LrVfmPrEs6J5qzio0WonSOis6E_i8WVDqKYN9Wl74O4i87Lrz7O41J-kYxiSIjH2gdjbpLqQ1FXtsdsFRQ1F3o7ps0xPdkv116ElEwvD4jbao1qNQI1MrvRQY2_Q6Q9GJAEmEUZROBps3AYG1ZN54Po-HaaNunHQDSAN4Um1CX_5o8q_ujU3bwBFdUqOe6WD4nqncnmpP-rwHlZP0fd5Ujj8bNSjIL8-PX_vVqO7H8IpN2NzJokz-MA' \
--data-raw '{
"code": "singlestoretestforcreation3",
"description": "SingleStoreTest",
"name": "singlestoretestforcreation3",
"type": "STORE",
"adminType": "GENERAL",
"isActive": true,
"timeZoneId": "",
"currencyId": "",
"languageId": "",
"parentConceptId": "75216471",
"parentZoneId": "75152646",
"externalIds": [
"nee11234"
],
"email": "[email protected]",
"mobile": "919686000000",
"landline": "",
"latitude": "",
"longitude": "",
"address": "",
"cityId": 0,
"areaId": 0
}'{
"code": "singlestoretestforcreation",
"description": "SingleStoreTest",
"name": "singlestoretestforcreation",
"type": "STORE",
"adminType": "GENERAL",
"isActive": true,
"timeZoneId": "",
"currencyId": "",
"languageId": "",
"parentZoneId": 50712290,
"parentConceptId": 50712302,
"externalIds": [
"Ex-93991234",
"Ex-93991237",
"Ex-93991235"
],
"email": "[email protected]",
"mobile": "917262178832",
"landline": "",
"latitude": "",
"longitude": "",
"address": "",
"cityId": 0,
"areaId": 0,
"customFields":{
"store_custom_field":"Single store test"
}
}Request body parameter
| Parameter (Parameters marked with * are mandatory) | Datatype | Description |
|---|---|---|
code* | String | Unique store code used for identification in the Capillary system. Must start with a lowercase letter or digit, followed by any combination of lowercase letters, digits, periods, underscores, and hyphens. Note: Spaces are not allowed. Minimum length is 1 and maximum length is 50. |
description | String | Description of the store. Note: Maximum length is 250 characters. |
name* | String | Name of the store. Allows uppercase and lowercase letters, numbers, underscores, and spaces. Special characters such as periods, hyphens, or other symbols are not allowed. Note: Maximum length is 100 characters. |
type | Enum | Type of the entity you are creating. Here, the entity is STORE. |
adminType | Enum | Type of admin user for the store. Allowed values: GENERAL, ADMIN. |
isActive | Boolean | Indicates whether the store is active. |
timeZoneId | Integer | Unique ID representing the timezone of the store’s geographical location. Example: 191 represents Asia/Kolkata. |
currencyId | Integer | Unique ID representing the base currency of the store’s location. Example: 230 – Singapore Dollar, 211 – Australian Dollar. |
languageId | Integer | Unique ID representing the language used at the store. Example: 393. |
parentZoneId | Integer | Unique ID identifying the zone where the parent store is located. Use the get org entities API to fetch zones. |
parentConceptId | Integer | Unique ID representing the logical group (Concept) of the store. Use the get org entities API to fetch concepts. |
externalIds* | Array | List of external identifiers associated with the store. |
email | String | Store email address. |
mobile | String | Store mobile number. |
landline | String | Store landline number. |
latitude | String | Latitude coordinate of the store. |
longitude | String | Longitude coordinate of the store. |
address | String | Physical address of the store. |
cityId | Integer | Unique ID for the city where the store is located. |
areaId | Integer | Unique ID for the area where the store is located. |
customFields | Array | Array containing the custom fields and their values. These store additional information related to the store. |
Response parameter
| Parameter | Description |
|---|---|
| createdId | Store ID generated for the store. |
| warnings | List of any warnings associated with the request. |
{
"createdId": 50770954,
"warnings": []
}API-specific error codes
| Error code | Description |
|---|---|
| 1220 | Store code exists |
| 1206 | Store name exists |
Country IDs by timezone
| country_id | timezone | std_offset | summer_offset |
|---|---|---|---|
| 312 | Europe/Andorra | UTC+01:00 | UTC+02 |
| 4 | Asia/Dubai | UTC+04:00 | NULL |
| 308 | Asia/Kabul | UTC+04:30 | NULL |
| 316 | America/Antigua | UTC-04:00 | NULL |
| 314 | America/Anguilla | UTC-04:00 | NULL |
| 309 | Europe/Tirane | UTC+01:00 | UTC+02 |
| 318 | Asia/Yerevan | UTC+04:00 | UTC+05 |
| 313 | Africa/Luanda | UTC+01:00 | NULL |
| 315 | Antarctica/McMurdo | UTC+12:00 | UTC+13 |
| 315 | Antarctica/South_Pole | UTC+12:00 | UTC+13 |
| 315 | Antarctica/Rothera | UTC-03:00 | NULL |
| 315 | Antarctica/Palmer | UTC-04:00 | UTC-03 |
| 315 | Antarctica/Mawson | UTC+06:00 | NULL |
| 315 | Antarctica/Davis | UTC+07:00 | NULL |
| 315 | Antarctica/Casey | UTC+08:00 | NULL |
| 315 | Antarctica/Vostok | UTC+00:00 | NULL |
| 315 | Antarctica/DumontDUrville | UTC+10:00 | NULL |
| 315 | Antarctica/Syowa | UTC+03:00 | NULL |
| 317 | America/Argentina/Buenos_Aires | UTC-03:00 | UTC-02 |
| 317 | America/Argentina/Cordoba | UTC-03:00 | UTC-02 |