Skip to main content
PUT
/
v1
/
channel
/
attribute
/
category
/
{categoryId}
Category Attributes
curl --request PUT \
  --url https://scx-sbx.api.jtl-software.com/v1/channel/attribute/category/{categoryId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributeList": [
    {
      "attributeId": "12323",
      "displayName": "Brand",
      "isMultipleAllowed": false,
      "type": "text",
      "values": [
        {
          "value": "Beer"
        },
        {
          "value": "Tee",
          "display": "Wine"
        }
      ],
      "attributeValueValidation": "/^[0-9]{13}$/",
      "conditionalMandatoryBy": [
        {
          "attributeId": "12323",
          "attributeValues": [
            "High"
          ]
        }
      ],
      "conditionalOptionalBy": [
        {
          "attributeId": "12323",
          "attributeValues": [
            "No Frame"
          ]
        }
      ],
      "required": true,
      "recommended": false,
      "section": "Colors and Appearance",
      "sectionPosition": 0,
      "isRepeatableSubSection": true,
      "subSection": "Length",
      "subSectionPosition": 0,
      "description": null,
      "isVariationDimension": true,
      "enumValues": [
        "Blue"
      ]
    }
  ]
}
'
{
  "errorList": [
    {
      "code": "VAL100",
      "message": "Required field sellerId not found",
      "severity": "error",
      "hint": "Check the field `sellerId` — it must be a non-empty string."
    }
  ]
}

Authorizations

​
Authorization
string
header
required

As a Channel Integrator you will receive a API Refresh Token. With such a Refresh Token you need to request an Access Token with a limited Lifetime (see POST /v1/auth). This Access Token must be provided as a Bearer Token in the Authorization Header with every request.

Headers

​
Content-Encoding
enum<string>

Use the Content-Encoding: gzip when sending JSON requestBody as compressed payload. This is recommended when creating huge category trees. There is a limit of 32 MB on this route.

Available options:
gzip

Path Parameters

​
categoryId
string
required

Assing attributes to a former created channel category. If no categoryId is provided the attribut will be assigned to the global channel scope, which means that every offer may require such an attribute.

Channel category Id

Required string length: 1 - 512
Example:

"Beer4711"

Body

application/json

List of attributes scoped to a single seller or to a specific category.

​
attributeList
object[]

Response

Attributes received