v2

latestSwagger 2.02026-07-31155351.0 KB

Manifests

Get manifest

Retrieve manifest paperwork for a previously successful ‘Manifest eligible orders’ endpoint call

get/manifests/{manifestIdentifier}

Path parameters

manifestIdentifierinteger required

The manifest number returned from the initial ‘Manifest eligible orders’ endpoint call

Response

The Get Manifest request was successfully processed. The manifest details were retrieved, but the Printable PDF Manifest may or may not be available at this time. Please try the Get Manifest endpoint. If it is not available after a reasonable period, please <a href='https://help.parcel.royalmail.com/hc/en-gb/articles/115003806094-Contact-Support' target='_self'>contact support</a> for assistance.

manifestNumbernumber required

status'In Progress' | 'Completed' | 'Failed'

documentPdfstring

manifest in format base64 string

Example response

{
  "manifestNumber": 1001,
  "status": "Completed",
  "documentPdf": "Base64 encoded PDF document"
}