Add Store

Allows org admins to add a store to an org.

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.

API endpoint example

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

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Access group resource: Read and write access to the Store resource
  • Admin of the organisation

Resource information

URIv2/orgEntity/store
HTTP MethodPOST
PaginationNA
Batch supportNA
Rate limit informationNA

Request body parameter

Parameter (Parameters marked with * are mandatory) Datatype Description

code*

String

Unique store code used for identification in the Capillary system. The string starts with a lowercase letter and includes lowercase letters, numbers, periods, underscores, and hyphens.
Note: Spaces between characters are not allowed. The maximum number of characters allowed is 50 and the minimum characters allowed is 1..

description

String

Description of the store.
Note: The maximum number of characters allowed is 250.

name*

String

Name of the store. The string includes uppercase and lowercase letters, numbers, underscores, and spaces. Special characters such as periods, hyphens, or other symbols are not allowed.
Note: The maximum number of characters allowed is 100.

type

Enum

Type of the entity you are creating. Here, the entity is STORE.

adminType

Enum

Type of admin user for the store.
** Values allowed **: 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 time zone.

currencyId

Integer

Unique ID representing the base currency of the store's location, corresponding to the currency of the country where the store operates.
Example: 230 - Singapore Dollar, 211 - Australian Dollars

languageId

Integer

Unique ID representing the language used at the store.
Example: 393

parentZoneId

Integer

Unique ID that identifies the zone where the parent store is located. Use the get org entities API to fetch Zones and map those entities to parent fields.

parentConceptId

Integer

Unique ID representing the logical group (Concept) of the store. Use the get org entities API to fetch Concepts, and map those entities to parent fields.

externalIds*

Array

List of external identifiers associated with the store.

email

String

Store's email address.

mobile

String

Store's mobile number.

landline

String

Store's 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 it's value. These custom fields store special or custom information related to the store.

{
    "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"
  }
}

Response parameter

ParameterDescription
createdIdStore ID generated for the store.
warningsList of any warnings associated with the request.

{
    "createdId": 50770954,
    "warnings": []
}

API-specific error codes

Error codeDescription
1220Store code exists
1206Store name exists
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!