Skip to content

Creation of parametric category definition

Request

Creates a new parametric category definition for a given category and set of parameters.

The definition specifies which parameters are used to generate parametric category pages for the specified category. You can specify 1 to 4 parameters. Each parameterCode must exist and must be unique within the request. Only one definition with the same set of parameters can exist per category.

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

Security
shoptetAccessToken or shoptetPrivateApiToken
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-definition \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "categoryGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "parameters": [
        {
          "parameterCode": "color"
        }
      ]
    }
  }'

Responses

Created

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