Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Store in bulk

Allows the org admin to add stores in bulk

post/orgEntity/store/bulk

Request body

codestring required

A unique store code used for identification in Capillary system.

descriptionstring

Description of the store.

namestring required

Name of the store.

typestring

Type of the entity you are creating.

adminType'`General`' | '`Admin`'

Type of admin user for the store. ** Values allowed**: General, Admin

isActiveboolean

Indicates if the store is active.

timeZoneIdinteger

Unique ID representing the timezone of the store's geographical location.

currencyIdinteger

Unique ID representing the base currency of the store's location, which corresponds to the currency of the country where the store operates.

languageIdinteger

Unique ID representing the language used at the store.

parentZoneIdinteger

Unique ID that identifies the zone where the parent store is located.

parentConceptIdinteger

Unique ID representing the logical group (Concept) of the store.

externalIdsstring[] required

List of external identifiers associated with the store.

emailstring

Store's email address.

mobilestring

Store's mobile number.

landlinestring

Store's landline number.

latitudestring

Latitude coordinate of the store.

longitudestring

Longitude coordinate of the store.

addressstring

Physical address of the store.

cityIdinteger

Unique ID for the city where the store is located.

areaIdinteger

Unique ID for the area where the store is located.

customFieldsstring[]

Array containing the custom fields and it's value. These custom fields store special or custom information related to the store.

Response

200

totalCountinteger
failureCountinteger

Example response

{
  "response": [
    {
      "entityId": 50757475,
      "result": {
        "id": 50757475,
        "code": "MaiHàGiangCutomField",
        "description": "MaiHàGiangCutomField",
        "name": "MaiHàGiangCutomField",
        "type": "STORE",
        "adminType": "GENERAL",
        "isActive": true,
        "timeZoneId": -1,
        "currencyId": -1,
        "languageId": -1,
        "parentZoneId": 50712290,
        "parentConceptId": 50712302,
        "externalIds": [
          "Ex-93991234"
        ],
        "email": "tom.swayer@capillarytech.com",
        "mobile": "917262178832",
        "customFields": {
          "store_custom_field": "store test"
        }
      }
    }
  ],
  "totalCount": 1
}