# List of variant parameters

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.

Value | Section
--------|------
values | Variant parameter values

Endpoint: GET /api/products/variant-parameters
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `include` (string)
    Optional parts of response
    Example: "values"

  - `itemsPerPage` (integer)
    Returned items per page. Default value is 50. Max value is 100.
    Example: 50

  - `page` (integer)
    Page number to return. Default value is 1.
    Example: 3

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.parameters` (array, required)

  - `data.parameters.id` (integer, required)
    ID of the parameter

  - `data.parameters.paramName` (string,null, required)
    name of the parameter

  - `data.parameters.paramIndex` (string, required)
    index of the parameter (identifier)

  - `data.parameters.displayName` (string,null)
    Parameter display name

  - `data.parameters.priority` (integer,null, required)
    priority of the parameter

  - `data.parameters.values` (array)
    Possible parameter values

  - `data.parameters.values.id` (integer, required)
    Parameter value id

  - `data.parameters.values.paramValue` (string, required)
    Description (name) of parameter's value

  - `data.parameters.values.rawValue` (string, required)
    Code (identifier) of parameter's value

  - `data.parameters.values.color` (string,null, required)
    Hex code of color

  - `data.parameters.values.image` (string,null, required)
    Url of image

  - `data.parameters.values.valuePriority` (integer,null, required)
    Parameter value priority

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object, required)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.