# List of surcharge parameters

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

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

## Query parameters:

  - `itemsPerPage` (integer)
    Returned items per page. Default and max value is 500.
    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.surchargeParameters` (array, required)

  - `data.surchargeParameters.id` (integer, required)
    Id of surcharge parameter. This identifier is used on eshop frontend.

  - `data.surchargeParameters.code` (string, required)
    Parameter code (identifier).

  - `data.surchargeParameters.name` (string, required)
    Name of surcharge parameter.

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

  - `data.surchargeParameters.description` (string,null, required)
    Description of surcharge parameter.

  - `data.surchargeParameters.priority` (integer,null, required)
    Priority of surcharge parameter.

  - `data.surchargeParameters.required` (boolean, required)
    If surcharge parameter is required.

  - `data.surchargeParameters.currency` (string, required)
    Currency of surcharge parameter.

  - `data.surchargeParameters.includingVat` (boolean, required)
    Is price of parameter's values including VAT.

  - `data.surchargeParameters.subscription` (boolean,null)
    Indicates whether this surcharge parameter is a subscription (recurring payment)

  - `data.surchargeParameters.googleMapping` (object,null, required)
    Possible parameter mapping with google.

  - `data.surchargeParameters.googleMapping.value` (string)
    Code (identifier) of google mapping parameter

  - `data.surchargeParameters.googleMapping.description` (string,null)
    Description (name) of google mapping parameter

  - `data.surchargeParameters.values` (array, required)
    Possible parameter's values.

  - `data.surchargeParameters.values.id` (integer, required)
    Id of surcharge parameter value. This identifier is used on eshop frontend.

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

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

  - `data.surchargeParameters.values.price` (string,null, required)
    Price of parameter's value

  - `data.surchargeParameters.values.priority` (integer,null, required)
    Priority of parameter's value

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