v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Carriers

Get Carriers

Retrieves a list of available carriers on the system along with their unique codes and descriptive details, enabling users to view and select from different carriers.

get/v4/carriers

Response

Returns a list of carriers.

CarrierCodestring required

A unique identifier for this carrier. This code is typically alphanumeric and serves as a reference to distinguish between various carriers within the system.

Namestring required

The official name of the carrier that provides users with a clear understanding of the carrier's identity.

Descriptionstring required

A detailed overview of the carrier's services, capabilities, and distinguishing features. This field provides additional information about the carrier, helping users understand their offerings and operational scope.

Example response

[
  {
    "CarrierCode": "RM",
    "Name": "Royal Mail",
    "Description": "Produces labels, required documentation, billing management for shipments sent via the Royal Mail network."
  }
]

All 207 operations