Couriers

List couriers

Returns every courier this build supports along with its capabilities. Use it to drive your own UI rather than hard-coding a list that will go stale.

curl https://api.shipstack.example/v1/couriers \
  -H "Authorization: Bearer $SHIPSTACK_API_KEY"

{
  "couriers": [
    {
      "code": "dpd",
      "name": "DPD",
      "capabilities": {
        "domestic": true,
        "international": true,
        "multi_piece": true,
        "max_parcels": 30,
        "label_formats": ["pdf", "zpl"],
        "void": true,
        "tracking": true,
        "options": {
          "signature_required": true,
          "age_check": true,
          "insurance": true,
          "saturday_delivery": true,
          "cash_on_delivery": false,
          "safe_place": true
        },
        "pickup_points": ["shop", "locker"]
      }
    }
  ]
}

Reading capabilities

Capabilities are not documentation. They are enforced. A request using an option or a lane a carrier does not support is rejected before any network call, so you get a clear error instead of a carrier-specific one.

Credential schema

Each courier declares the credential fields it needs. This is what Shipstack Manager renders its settings forms from, and it is available to you for the same purpose.

curl https://api.shipstack.example/v1/couriers/dpd/schema \
  -H "Authorization: Bearer $SHIPSTACK_API_KEY"

Currently supported

Every integration below is implemented and conformance-tested, and is in beta pending validation against live carrier accounts. See the full capability matrix for the detail.