Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Carriers

Get Carrier

Retrieves detailed information about a specific carrier, including its services, logo, and operational information, based on the provided carrier code.

get/v4/carriers/{carrierCode}

Path parameters

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.

Response

Returns the details of a carrier.

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.

LogoFormat'PNG' | 'JPG' | 'GIF' required

The format of the carrier's logo image, typically indicated by a file extension, for example PNG, JPG, and GIF. This informs the user about the type of image file that is used for the carrier's branding.

LogoBase64string required

A Base64-encoded string of the carrier's logo image in the format specified in the LogoFormat object. This allows for the direct embedding of the logo within the system, eliminating the need for separate image retrieval.

CarrierTimezonestring nullable

The timezone in which the carrier operates. This information is essential for scheduling and coordination, as it indicates the local time for the carrier's operations and services, for example, London/Europe.

Example response

{
  "CarrierCode": "RM",
  "Name": "Royal Mail",
  "Description": "Produces labels, required documentation, billing management for shipments sent via the Royal Mail network.",
  "LogoBase64": "R0lGODlhYQBBAPf/AOjMmdsqOP3hHPqtHfmcHf3RHLa+vfPy8fAAH/vBHfH...",
  "CarrierTimezone": "London/Europe"
}