Use this API to create attribute values for existing product attributes. Attribute values define the allowed options that can be assigned to an attribute.

For example, if you create an attribute called Color, you can define values such as Red, Blue, and Green. These values standardise product data and ensure consistent classification across your catalogue.

What this API supports

• Bulk creation of attribute values (up to 100 per request)
• Association with an existing attribute using attributeCode
• Optional OU-scoped attribute values
• Separate value sets per organisation unit, if required

Limits and configuration

• You can create up to 100 attribute values per request. This limit is controlled by CONF_PRODUCT_CREATE_UPDATE_BATCH_SIZE.
• By default, you can create up to 100 values per attribute. This limit is controlled by org_product_custom_attribute_value_limit.
• You can raise a JIRA ticket to modify these configuration values.

Default and validation behaviour

• The parent attribute must already exist.
• The code must be unique within the same attribute.
• If name is not provided, the API uses the code as the display name.
• If ouCode is not provided, the attribute value is created at the organisation level (ouId = -1).
• If the attribute ID is invalid, the API returns an error and does not create the value.

Organisation unit (OU) behaviour

• You can scope attribute values to a specific OU using ouCode.
• OU-scoped values require OU support to be enabled.
• Org-level and OU-level values are stored separately.

Example request

curl --location 'https://eu.api.capillarytech.com/v2/product/attributeValues' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86NjVhMDgzYjk1MWY5MGY1NTY5NDk1YmNkNzUxYmJiY2U=' \
--header 'Cookie: _cfuvid=WEe5YUE2FwJBe7O0wzcDvSNI44nigxpVw3YBGB2zmFM-1772180246584-0.0.1.1-604800000' \
--data '[
    {
        "attributeCode": "orange",
        "ouCode": "invalid",
        "code": "efkejrfhkejrfh",
        "name": "EWRFEFRE"
    },
    {
        "attributeCode": "orange",
        "code": "efjhekrjfkej",
        "name": "VFGVFG"
    }
]'

Prerequisites

• Access Group: You must have WRITE access to the Product resource.
  • Attribute Exists: The parent attribute (specified by attributeCode) must already exist. Use the Add Product Attributes API to create attributes first.
• OU Configuration: If you intend to scope attribute values to specific Organization Units (OUs), ensure OU support for product entities is enabled.

Body parameters

API Quick Reference

{{https://{host}.api.capillarytech.com/v2/product/attributeValues}}
   └─ {{RequestBody}} (Batch Array)
      ├─ {{attributeCode}} (long)
      ├─ {{code}} (string)
      ├─ {{name}} (string)
      ├─ {{ouCode}} (string)
      └─ {{ResponseBody}}
          ├─ {{created}} []
          │   ├─ {{id}} (long)
          │   ├─ {{attributeId}} (long)
          │   ├─ {{code}} (string)
          │   ├─ {{ouId}} (integer)
          │   └─ {{ouCode}} (string)
          ├─ {{summary}}
          │   ├─ {{totalRequested}} (integer)
          │   ├─ {{successCount}} (integer)
          │   └─ {{failureCount}} (integer)
          ├─ {{warnings}} []
          └─ {{errors}} []

Example response

{
    "created": [
        {
            "id": 13567890,
            "attributeId": 91459,
            "code": "red",
            "ouId": -1
        },
        {
            "id": 13567891,
            "attributeId": 91459,
            "code": "blue",
            "ouId": 50025951,
            "ouCode": "zone_north_01"
        }
    ],
    "summary": {
        "totalRequested": 2,
        "successCount": 2,
        "failureCount": 0
    },
    "warnings": [],
    "errors": []
}

Response parameters

Error codes