# List of parametric categories

Returns the list of product categories.

Endpoint: GET /api/parametric-categories
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `include` (string)
    Include additional data in response. Possible values: parameters.
    Example: "parameters"

  - `itemsPerPage` (integer)
    Returned items per page. Default and max value is 100.
    Example: 90

  - `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.parametricCategories` (array, required)

  - `data.parametricCategories.guid` (string, required)
    unique identifier of the category

  - `data.parametricCategories.name` (string, required)
    category name

  - `data.parametricCategories.indexName` (string, required)
    ending part of category URL

  - `data.parametricCategories.url` (string, required)
    category URL in the e-shop

  - `data.parametricCategories.description` (string,null, required)
    top category description

  - `data.parametricCategories.secondDescription` (string,null, required)
    bottom category description

  - `data.parametricCategories.image` (string,null, required)
    header image

  - `data.parametricCategories.title` (string,null, required)
    HTML title element in the HTML header of the category page

  - `data.parametricCategories.metaTagDescription` (string,null, required)
    HTML META header Description in category page

  - `data.parametricCategories.originalCategoryGuid` (string,null, required)
    unique identifier of the original category (from which was the parametric category created)

  - `data.parametricCategories.showInList` (boolean, required)
    flag, whether the category is visible in product list

  - `data.parametricCategories.showInDetail` (boolean, required)
    flag, whether the category is visible in product detail

  - `data.parametricCategories.parameters` (array)
    parameters of the parametric category (requires parameters include in the request url)

  - `data.parametricCategories.parameters.parameterCode` (string, required)
    Code of the parameter

  - `data.parametricCategories.parameters.parameterName` (string, required)
    Name of the parameter

  - `data.parametricCategories.parameters.valueCode` (string, required)
    Code of the parameter value

  - `data.parametricCategories.parameters.valueName` (string, required)
    Name of the parameter value

  - `data.paginator` (object)

  - `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.

## Response 403 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `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)

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