GET /carriers

List carriers available to the API key's company, based on its pricing group. Use returned code values as shippingType.carrier on Rate.

Scope: (none — any valid public-api key)

Request body

None.

Success response (200)

Returns a JSON array in data. Internal fields are removed (pk, sk, entityType).

Field	Type	Description
code	string	Carrier code — use as shippingType.carrier on Rate
shortName	object	Localized short name (en, fr, …)
fullName	object	Localized full name

{
  "data": [
    {
      "code": "federal-express",
      "shortName": { "en": "FedEx" },
      "fullName": { "en": "FedEx" }
    },
    {
      "code": "ups-parcel",
      "shortName": { "en": "UPS" },
      "fullName": { "en": "UPS" }
    }
  ]
}

Error responses

HTTP	Condition
401	Missing/invalid/expired API key
500	Internal error