Use this API to create custom product attributes. Product attributes define additional properties that describe and classify products beyond core fields such as SKU, price, brand, and category.

Attributes act as the metadata layer of your catalogue. You can use them to model characteristics such as material, size, season, or any custom property required by your business.

What this API supports

• Bulk creation of attributes (up to 100 per request)
• Definition of attribute data types (String, Int, Double, Boolean)
• Optional OU-scoped attribute creation
• Setting a default value for an attribute
• Creating a default value inline using valueCode

Limits and configuration

• You can create up to 100 attributes per request. This limit is controlled by CONF_PRODUCT_CREATE_UPDATE_BATCH_SIZE.
• By default, an organisation can create up to 30 custom attributes. This limit is controlled by org_product_custom_attribute_limit.
• You can raise a JIRA ticket to modify these configuration values.

Default and OU behaviour

• If type is not provided, the API defaults it to String and returns warning code 10209.
• If ouCode is not provided, the attribute is created at the organisation level (ouId = -1).
• OU-scoped attributes require OU support to be enabled.
• Attribute codes are immutable after creation.

Example request

curl --location 'https://{host}.api.capillarytech.com/v2/product/attributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <auth_token>' \
--data '[
  {
    "code": "material_type",
    "name": "Material Type",
    "type": "String"
  },
  {
    "ouCode": "zone_north_01",
    "code": "seasonal_stock",
    "name": "Seasonal Stock",
    "type": "Int",
    "defaultValueId": 101
  }
]'

Prerequisites

• Access Group: You must have WRITE access to the Product resource.
• OU Configuration: If you intend to scope attributes 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/attributes}}
   └─ {{RequestBody}} (Batch Array)
      ├─ {{code}} (string)
      ├─ {{name}} (string)
      ├─ {{type}} (string)
      ├─ {{ouCode}} (string)
      ├─ {{defaultValueId}} (long)
      ├─ {{valueCode}} (string)
      └─ {{ResponseBody}}
          ├─ {{created}} []
          │   ├─ {{responseId}} (integer)
          │   ├─ {{responseOuId}} (integer)
          │   └─ {{responseCode}} (string)
          ├─ {{summary}}
          │   ├─ {{totalRequested}} (integer)
          │   ├─ {{successCount}} (integer)
          │   └─ {{failureCount}} (integer)
          ├─ {{warnings}} []
          └─ {{errors}} []

Example response

{
    "created": [
        {
            "id": 91459,
            "ouId": 50025951,
            "code": "productcolour"
        },
        {
            "id": 91458,
            "ouId": 50025951,
            "code": "producttype"
        }
    ],
    "summary": {
        "totalRequested": 2,
        "successCount": 2,
        "failureCount": 0
    },
    "warnings": [],
    "errors": []
}

Response parameters

Error codes

Warning codes