v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Stores in Bulk

Create up to 100 stores in a single request.

post/v2/locations/stores

Query parameters

inheritLocaleboolean

When true, inherits missing locale fields (language, currency, timezone) from the parent zone.

Headers

Authorizationstring

X-CAP-API-OAUTH-TOKENstring

Request body

codestring required

Unique store code. Lowercase letters, digits, periods, underscores, hyphens. Max 50 characters.

namestring required

Display name. Letters, digits, underscores, and spaces. Cannot equal ROOT.

areaParentCodestring required

Code of the parent zone. Must be an existing active zone.

groupParentCodestring required

Code of the parent concept. Must be an existing active concept.

languagestring

IETF BCP 47 language code (e.g. en-IN). Required when inheritLocale is false.

currencystring

ISO 4217 currency code (e.g. INR). Required when inheritLocale is false.

timezonestring

IANA timezone name (e.g. Asia/Kolkata). Required when inheritLocale is false.

descriptionstring

Free-text description of the store.

isActiveboolean

Whether the store is active. Defaults to true when omitted.

isAdminboolean

Whether the store has admin access. Defaults to false.

latitudestring

Latitude coordinate of the store.

longitudestring

Longitude coordinate of the store.

emailstring

Contact email address for the store.

mobilestring

Contact mobile number for the store.

landlinestring

Contact landline number for the store.

externalIdsobject

Key-value pairs of external identifiers. Max five entries. Keys and values must be non-blank and max 200 characters each.

customFieldsobject

Custom field key-value pairs. Keys must match custom fields configured for the org.

Response

All stores created successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.