v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Delivery checkout

Get carriers

The endpoint will return all carriers valid for delivery checkouts.

get/shipping_modules/carriers

Query parameters

receiver_country_codestring
Example:DK

Will limit the results to only contain carriers that are valid for the given country.

own_agreement_onlyboolean
Example:true

Will limit the results to only contain carriers for which your account has an active agreement.

Response

Successful.

namestring

The name of the carrier for display purposes.

codestring

The code of the carrier used in further requests.

Example response

[
  {
    "name": "GLS",
    "code": "gls"
  }
]