Skip to content

List of variant parameters

Request

Returns the list of available variant parameters with their available values within the e-shop.

List of variant parameters endpoint has section, which is only sent when requested in the include parameter.

ValueSection
valuesVariant parameter values
Security
shoptetAccessToken or shoptetPrivateApiToken
Query
includestring

Optional parts of response

Example:include=values
itemsPerPageinteger

Returned items per page. Default value is 50. Max value is 100.

Example:itemsPerPage=50
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/products/variant-parameters?include=values&itemsPerPage=50&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

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