JSON Response Structure and Format

The Create Shipment Response contents can differ based on the content on the request – if the request is successful and the Action was not set as Create or Allocate, a Base64 encoded PDF image will be included in the response. The image will be formatted to be printed to a 6*4 inch label.

If the Shipment Action was set as Create or Allocate, or if the request was unsuccessful, then a label will not be returned in the response.

Depending on the original request action, the Domestic Shipment success response message is
comprised of the following content.

👍

Success Message field definitions:

Based upon the details above, the success message returned will contain a different set of fields for a successful creation of a shipment. The fields, data types and conditions validated for in this section as detailed below.