# Refresh

Used to obtain the access token and current configuration.
Access token is required for authorization of requests for order creation and submission.
The configuration provides information about delivery options of the carriers (which carriers can be used for delivery in given country).
The configuration also includes information about enrichments and validation rules for the given carrier.

Endpoint: POST /integration/v1/refresh
Version: 0.0.1
Security: ApiKey

## Header parameters:

  - `X-Api-Key` (string, required)

  - `X-Sender-Profile` (string, required)

## Response 200 fields (application/json):

  - `accessToken` (string, required)
    JSON Web Token required for authorization of requests for order creation and submission.

  - `apiKeys` (object, required)

  - `apiKeys.dpd` (string, required)
    API key required for DPD map widget to work.

  - `apiKeys.packeta` (string, required)
    API key required for PACKETA map widget to work.

  - `routes` (array, required)
    An array of objects, where each object contains carriers and their configuration for a single route.

  - `routes.countryFrom` (string, required)
    Sender country (start of the route).
    Example: "SK"

  - `routes.countryTo` (string, required)
    Consignee country (end of the route).
    Example: "NL"

  - `routes.carriers` (object, required)

  - `routes.carriers.homeDelivery` (array, required)
    Carriers that support home delivery on given route.

  - `routes.carriers.homeDelivery.publicId` (integer, required)
    Public identifier of the carrier.
Use this value to identify the carrier in order creation process.

  - `routes.carriers.homeDelivery.name` (string, required)
    The name of the carrier that will deliver the shipment.
    Example: "DHL"

  - `routes.carriers.homeDelivery.logo` (string, required)
    URI on which logo of this carrier can be downloaded.

  - `routes.carriers.homeDelivery.cooperatingCarrierName` (string,null)
    Name of the carrier that will pick up the shipment.
    Example: "Packeta"

  - `routes.carriers.homeDelivery.cooperatingCarrierLogo` (string,null)
    URI on which logo of a cooperating carrier can be downloaded.

  - `routes.carriers.homeDelivery.pickupType` (string, required)
    Pickup type configured for the carrier.
Possible values: R (regular), I (irregular), D (drop-off)
    Example: "R"

  - `routes.carriers.homeDelivery.enrichments` (object, required)

  - `routes.carriers.homeDelivery.enrichments.maxCod` (object, required)

  - `routes.carriers.homeDelivery.enrichments.maxCod.amount` (number, required)
    Amount of the money.
    Example: 4.99

  - `routes.carriers.homeDelivery.enrichments.maxCod.currency` (string, required)
    Currency ISO code from ISO 4217.
    Example: "EUR"

  - `routes.carriers.homeDelivery.enrichments.maxParcelValue` (object, required)

  - `routes.carriers.homeDelivery.enrichments.icc` (boolean, required)
    True, if ID card check is supported by the carrier on given route.

  - `routes.carriers.homeDelivery.validations` (object, required)

  - `routes.carriers.homeDelivery.validations.consigneePhoneNumberFormat` (boolean, required)
    True, if recipient's phone number format must be valid for the country.
For example, if recipient's country is SK and this value is true, then recipient's phone number must start with +421 (phone number prefix for SK).

  - `routes.carriers.parcelShopDelivery` (array, required)
    Carriers that support parcel shop delivery on given route.


## Response 401 fields