# Creation of surcharge parameter

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

## Header parameters:

  - `Content-Type` (string, required)

## Request fields (application/json):

  - `data` (object, required)

  - `data.currency` (string,null)
    set currency value, if is not present, default currency is chosen.

  - `data.displayName` (string,null)
    Name of surcharge parameter.

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

  - `data.code` (string)
    Url friendly name of parameter. If is not set, code is generated from name. When changed, you must use the new code in the next API calls.

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

  - `data.required` (boolean)
    default value is false.

  - `data.includingVat` (boolean)
    default value is true.

  - `data.priority` (integer,null)
    Parameter priority

  - `data.googleMapping` (string,null)
    Mapping for google.

  - `data.values` (array, required)
    Values of parameter.

  - `data.values.name` (string, required)
    Name of parameter value

  - `data.values.price` (string,null, required)
    Additional price of surcharge parameter.

  - `data.values.valueIndex` (string,null)
    Url friendly name of parameter value. Maximal length of 255 characters. If is not set, code is generated from name.

  - `data.values.priority` (integer,null)
    Priority of parameter value.

## Response 201 fields (application/json):

  - `data` (object, required)

  - `data.surchargeParameter` (object, required)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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