Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Concepts in Bulk

Create up to 100 concepts in a single request.

post/v2/locations/concepts

Query parameters

inheritLocaleboolean

When true, inherits missing locale fields from the parent concept. Requires a valid groupParentCode.

Headers

Authorizationstring
X-CAP-API-OAUTH-TOKENstring

Request body

codestring required

Unique code for the concept in the org. Accepts lowercase letters, digits, periods (.), underscores (_), and hyphens (-). Must start with a lowercase letter or digit. Max 50 characters.

namestring required

Display name for the concept. Accepts letters, digits, underscores, and spaces. Cannot equal root (any case). Max 100 characters.

groupParentCodestring

Code of the parent concept this concept belongs to. When provided, must be an existing active concept in the org. Omit to create a root-level concept.

languagestring

IETF BCP 47 language code for the concept (for example, en-IN). Required when inheritLocale is false. Must be enabled for the org.

currencystring

ISO 4217 currency code for the concept (for example, INR). Required when inheritLocale is false. Must be enabled for the org.

timezonestring

IANA timezone name for the concept (for example, Asia/Kolkata). Required when inheritLocale is false. Must be enabled for the org.

descriptionstring

Free-text description of the concept.

isActiveboolean

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

isOrgUnitboolean

Whether this concept acts as an organizational unit. When omitted, the field is not set.

externalIdsobject

Object containing key-value pairs of external identifiers for the concept. Maximum five entries. Keys and values must be non-blank and no longer than 200 characters each. Values must be unique within the request and not already assigned to another entity in the org.

customFieldsobject

Object containing custom field key-value pairs for the concept. Keys must match custom fields configured for the org (matched case-insensitively).

Example request

[
  {
    "code": "concept-retail",
    "name": "Retail Concept",
    "groupParentCode": "concept-root",
    "language": "en-IN",
    "currency": "INR",
    "timezone": "Asia/Kolkata",
    "description": "Retail channel concept",
    "isActive": true,
    "externalIds": {
      "erpId": "ERP-C-001"
    },
    "customFields": {
      "conceptcf1": "value1"
    }
  }
]

Response

All concepts created successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.