JSON Response Structure and Format
The Manifest Details section is where the Base64 encoded image and the unique manifest number and other shipment details are returned.
The fields, data types and conditions that will be validated for in this section as detailed below.
The Manifest Details contains a nested sub-section called ShippingLocation. This is where the stored information on the despatch location details are returned.
The fields, data types and conditions that will be validated for in this section as detailed below.
The ShippingAccount section is where the stored information on the senders shipping account details are returned.
The fields, data types and conditions that will be validated for in this section as detailed below.
This section details the format of the error section, should the request message not pass validation.
For a Manifest Shipmen Response message, the system may respond with errors. This then tells the receiving system that the original Manifest Shipment request was not successfully processed.
The errors message will only ever be returned if there are errors, if there are no errors, then this information will be left out of the response entirely.
The fields, data types and conditions that will be validated for in the errors section as detailed below.
The successful response to a Manifest Shipment Request may include 1 Base64 Encoded image of a Customer Collection Receipt.
The ManifestImage element in the response will always contain an RMG Customer Collection Receipt when Manifesting Royal Mail Labels. The request will contain an error if you try to manifest Royal Mail shipments and other carriers in the same request
Updated 9 months ago