v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

Attributes

Category Attributes

Create Attributes which are required for listings in specific category.

put/v1/channel/attribute/category/{categoryId}

Path parameters

categoryIdstring required

Channel category Id

Example:Beer4711

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.

Headers

Content-Encoding'gzip'

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.

Request body

Example request

{
  "attributeList": [
    {
      "attributeId": "12323",
      "displayName": "Brand",
      "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,
      "section": "Colors and Appearance",
      "isRepeatableSubSection": true,
      "subSection": "Length",
      "isVariationDimension": true,
      "enumValues": [
        "Blue"
      ]
    }
  ]
}

Response

Attributes received