PAparcelsapp
Delivery Estimates

Find canonical carrier slugs (beta)

Beta companion to delivery estimates. Searches carrier names and aliases for use in delivery-estimate requests. transport_modes lists only the modes supported by that canonical carrier; callers must use one of those values. Ambiguous names such as a global network with several country branches are returned as separate canonical slugs.

get/carriers

Request

Query parameters

querystring
transport_mode'parcel' | 'postal' | 'express' | 'road_freight' | 'air_cargo' | 'ocean_container'

Concrete transport mode. Forecast fallback never crosses this boundary.

limitinteger

Response

Matching carriers.

querystring required
transport_mode'parcel' | 'postal' | 'express' | 'road_freight' | 'air_cargo' | 'ocean_container'

Concrete transport mode. Forecast fallback never crosses this boundary.

total_matchesinteger required
has_moreboolean required

Example response

{
  "query": "Sutton Transport",
  "carriers": [
    {
      "slug": "sutton-transport",
      "name": "Sutton Transport",
      "aliases": [
        "Sutton Transport"
      ],
      "transport_modes": [
        "road_freight"
      ]
    }
  ],
  "total_matches": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.