JSON

JSON Request Structure and Format:

The Carriers requests JSON messages are comprised of the following sections.

For further details on the standard JSON message formatting, please refer to the Shipping API JSON Formatting Rules.

In order to successfully process a Get Carriers request, the user must have a valid connection, that has been verified by use of a system generated Authentication Token. For further details on system authentication, please refer to the Authentication guide.

Carrier Code section

This section details the carrier code that further information is required on, for the purpose of this documentation that CarrierCode is only for Royal Mail Group and the value will be “RM”.

Within this part of the message, the user needs to send the carrier code. This then tells the receiving system that it is going to receive a request for the details of a carrier. The system can thereby validate the data contained in this section accordingly. Depending on the path that is used for the request, the returned information is different.

• If the Path = /v4/Carriers/{CarrierCode} – Then the information returned will be information specific to the carrier, such as the carrier code and logo name.
• If the Path = /v4/Carriers/{CarrierCode}/Services – Then the system will return all the services available for the selected carrier.
• If the Path = /v4/Carriers/{CarrierCode}/Services/{ServiceCode}/PackageType – Then the system will return all the package types that are allowed for a specific carrier service

The fields, data types and conditions that will be validated for in the Carrier Codes section as detailed below.

Example Request JSON:

In the table below is a Get Carrier Request XML example, this has been placed into a table, to better separate and distinguish the different sections detailed above.

JSON Response Structure and Format:

The Get Carriers response JSON message is comprised of the following sections.

Carrier Information section

If the request to Get Carriers was successfully processed through the Shipping API, then this section will contain the relevant information based on the path that was used to make the request.

The fields, data types and conditions that will be validated for in the shipment destination section as detailed below.

MaxDimension subsection

If the request to Get Package type information for a specific service for a Carrier was successfully processed through the Shipping API, then this section may contain the relevant package dimension information.

The fields, data types and conditions that will be validated for in the shipment destination section as detailed below.