# Adding a shipping method

Adds a new shipping method for the specific e-shop.

Should you wish to implement an addon implementing a shipping method,
contact our partner support and request the creation

of a new "shipping company code" identifier.


The request body includes the mandatory attributes name and
shippingMethodCode (or deprecated shippingCompanyCode). The other
parameters are not

mandatory and their default values will be used:


- description - null


- visibility - false


- wholesale - false


- logo - null


- minimalShippingPrice - 0.00


Send the logo of the shipping method as the file content, encoded with
base64, in data.logo.content request item.


Please note that name cannot be longer than 255 characters.

Endpoint: POST /api/shipping-methods
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Header parameters:

  - `Content-Type` (string, required)

## Request fields (application/json):

  - `data` (object, required)

  - `data.name` (string, required)
    Name of the shipping method

  - `data.description` (string,null)
    additional information about the shipping method.

  - `data.shippingMethodCode` (string, required)
    type of shipping method (operator) - identifier assigned by Shoptet

  - `data.visibility` (boolean)
    whether the shipping method will be visible

  - `data.wholesale` (boolean)
    flag, whether the shipping method is available for wholesale customers (false = for retail)

  - `data.logo` (object)

  - `data.logo.filename` (string, required)
    Name of the file

  - `data.logo.content` (string, required)
    Base64 encoded image

  - `data.minimalShippingPrice` (string,null)
    number indicating minimum price of shipping in the default currency

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.guid` (string, required)
    Unique identifier of the shipping method

  - `data.name` (string, required)
    name of shipping method, as can be seen in e-shop.

  - `data.description` (string,null, required)
    additional information about the shipping method. (can be null)

  - `data.visibility` (boolean, required)
    Is the shipping method visible?

  - `data.wholesale` (boolean, required)
    Is the shipping method available for wholesale customers?

  - `data.logoUrl` (string,null, required)
    URL of the shipping company logo

  - `data.shippingCompany` (object, required)

  - `data.shippingCompany.id` (integer, required)
    shipping method ID.

  - `data.shippingCompany.code` (string, required)
    shipping company identifier.

  - `data.shippingCompany.name` (string, required)
    shipping company name.

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


