API Documentation

Add Store in bulk

post
https://{host}/v2/orgEntity/store/bulk

Allows the org admin to add stores in bulk

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A unique store code used for identification in Capillary system.

string

Description of the store.

string
required

Name of the store.

string

Type of the entity you are creating.

string
enum

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

Allowed:
boolean

Indicates if the store is active.

int32

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

int32

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

int32

Unique ID representing the language used at the store.

int32

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

int32

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

externalIds
array of strings
required

List of external identifiers associated with the store.

externalIds*
string

Store's email address.

string

Store's mobile number.

string

Store's landline number.

string

Latitude coordinate of the store.

string

Longitude coordinate of the store.

string

Physical address of the store.

int32

Unique ID for the city where the store is located.

int32

Unique ID for the area where the store is located.

customFields
array of strings

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

customFields
Responses

Updated 25 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago