v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update Stores in Bulk

Update up to 100 stores in a single request.

put/v2/locations/stores

Query parameters

inheritLocaleboolean

When true, locale fields are inherited from the parent zone when not explicitly provided.

Headers

Authorizationstring

X-CAP-API-OAUTH-TOKENstring

Request body

identifierNamestring required

Identifier type. Must be one of: ID, CODE, EXTERNAL_ID. Case-insensitive.

identifierValuestring required

The value for the given identifier type.

namestring

Display name. Cannot be set to null or empty. Cannot equal ROOT (any case). Max 100 characters. Accepts letters, digits, underscores, and spaces.

descriptionstring nullable

Free-text description. Set to null to clear.

isAdminboolean

isActiveboolean

latitudestring nullable

longitudestring nullable

emailstring nullable

mobilestring nullable

landlinestring nullable

areaParentCodestring

Code of the parent zone. Cannot be set to null.

groupParentCodestring

Code of the parent concept. Cannot be set to null.

externalIdsobject nullable

Key-value map of external identifiers. Omit to preserve. Set to null to clear all. Set a key's value to null to remove that specific key. Pass {} to make no change. Maximum five entries. Keys and values must not exceed 200 characters each.

customFieldsobject nullable

Key-value map of custom field values. Omit to preserve. Set to null to clear all. Set a key's value to null to remove that specific key. Pass {} to make no change. Keys must match custom fields configured for the org.

languagestring

IETF BCP 47 language code.

currencystring

ISO 4217 currency code.

timezonestring

IANA timezone name.

Response

All stores updated successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.