Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Carrier Integration Service Contract

Get available carriers

The request a Xentral instance makes to an external carrier service to get a list of available carriers and their products. This request will be made when a user wants to create a new shipping method.

get/xentral/carriers

Headers

Accept-Languagestring required

ISO 15897 locale.

Example:de-DE

The used locale of the user making the request. Use this header to determine the language of the localised fields in the response

Response

Response body for getting available carriers and their products

Example response

{
  "carriers": [
    {
      "name": "Post Swiss",
      "id": "post-ch",
      "products": [
        {
          "id": "post-ch-express",
          "name": "Express",
          "description": "The express shipping method of Post Swiss",
          "label": {
            "type": [
              "pdf"
            ],
            "size": [
              "A4"
            ],
            "orientation": [
              "portrait"
            ]
          },
          "insurance": {
            "available": true
          },
          "shipmentType": [
            "outbound",
            "return"
          ]
        }
      ]
    }
  ]
}