Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Delivery checkout

Get valid products

The endpoint will return all products for the given carrier code.

get/shipping_modules/products

Query parameters

carrier_codestring required
Example:gls

The carrier code to find products for.

own_agreement_onlyboolean
Example:true

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

Response

Successful.

namestring

The name of the product for display purposes.

product_codestring

The product code used in further requests.

service_point_productboolean

Whether or not the product is used with service points

receiver_countriesstring[]

Array of country codes where the product can be used by your account.

Example response

[
  {
    "name": "ShopDelivery",
    "product_code": "GLSDK_SD",
    "service_point_product": true,
    "receiver_countries": [
      "DK"
    ]
  }
]