Skip to content

Creation of parametric category

Request

Creates a new combination for a parametric category.

Prerequisites: Before creating a combination, a parametric category definition for the selected parameterCodes and the given category must exist. Create one via POST /parametric-categories-definition. To discover which parameterCodes are available for a category, use GET /parametric-categories-available-parameters.

You can create only one parametric category combination for each combination of parameterCode and valueCode.

The "Advanced SEO" module must be active to use this endpoint.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
includestring

Include additional data in response. Possible values: parameters.

Example:include=parameters
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobjectrequired
curl -i -X POST \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/parametric-categories?include=parameters' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "name": "Green XL",
      "originalCategoryGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "parameters": [
        {
          "parameterCode": "color",
          "valueCode": "red"
        }
      ],
      "indexName": "green-xl",
      "description": "<p>Top parametric category description</p>",
      "secondDescription": "<p>Bottom parametric category description</p>",
      "sourceImageName": "image.png",
      "title": "Green XL t-shirt",
      "metaTagDescription": "Green t-shirt, t-shirt xl, green, xl",
      "showInList": true,
      "showInDetail": true
    }
  }'

Responses

Created

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "parametricCategory": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}