List couriers

Get Transdirect’s list of couriers and services, with the courier id for each. Use it to show courier names, for example in your own settings screen.

GET /api/v5/couriers

No API key needed.

Example request

curl https://api.transdirect.com.au/api/v5/couriers

import { getApiV5Couriers } from '@transdirect/api-sdk';

const { data, error } = await getApiV5Couriers();
if (!data) throw new Error(JSON.stringify(error));
console.log(data['TNT Express']['Road Express']); // "tnt_road_express"

Response

200 OK. A courier with one service maps its name straight to its id. A courier with several services maps to an object of service name to id.

{
  "Allied": {
    "Allied": "allied",
    "Allied Pallet": "allied_pallet"
  },
  "Couriers Please": "couriers_please",
  "Team Global Express": {
    "Team Global Express IPEC": "team_global_express",
    "Team Global Express Priority": "team_global_express_priority",
    "Team Global Express Specialised": "team_global_express_specialised"
  },
  "Northline": "northline",
  "TNT Express": {
    "9AM": "tnt_nine_express",
    "10AM": "tnt_ten_express",
    "12PM": "tnt_twelve_express",
    "Overnight": "tnt_overnight_express",
    "Road Express": "tnt_road_express"
  },
  "Fedex": {
    "Fedex International Economy Document Export": "fedex_international_economy_document_export",
    "Fedex International Economy Document Import": "fedex_international_economy_document_import",
    "Fedex International Economy Export": "fedex_international_economy_export",
    "Fedex International Economy Import": "fedex_international_economy_import"
  },
  "Direct Couriers": {
    "Regular": "direct_couriers_regular",
    "Express": "direct_couriers_express",
    "Elite": "direct_couriers_elite"
  },
  "Sampson Express": "sampson_express",
  "Go People": "go_people",
  "Capital Transport": {
    "Capital Transport": "capital_transport",
    "Capital Transport Express": "capital_transport_express"
  },
  "Hunter Road Freight": "hunter_road_freight",
  "Xpress": "xpress",
  "Aramex": "aramex"
}

How courier ids are used

The ids are the keys of the quotes object in a quote response, and the value you send as courier when you confirm a booking.

Send this	Not this
`tnt_road_express`	`tnt` or `TNT Express`
`couriers_please`	`couriersplease` or `Couriers Please`
`hunter_road_freight`	`hunter`
`direct_couriers_express`	`direct_couriers`

You do not choose couriers when you quote. A quote asks every courier available to your key, and you pick one when you confirm.

What this list does not tell you

Which couriers will quote. The list is the same for everyone and does not depend on your account, route or items. Only a quote tells you who can carry a shipment and at what price.
Every id you can receive. Quotes can include services that are not listed here, such as other international services. In demo mode quotes also include demo, which is not listed.

Always confirm with a key taken from the quote response for that booking.

Try it

Open the API Explorer and find List supported couriers. No key is needed.