Manifests

Retry a manifest operation if the eligible orders were not able to be successfully processed in the initial ‘Manifest eligible orders’ endpoint call and return manifest paperwork where possible

post/manifests/retry/{manifestIdentifier}

Request

  • Base URL
    https://api.parcel.royalmail.com/api/v1
  • URL
    https://api.parcel.royalmail.com/api/v1/manifests/retry/{manifestIdentifier}
  • Auth
    API key in header Authorization

Path parameters

manifestIdentifierinteger required

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

Response

The Retry Manifest request was successful, and a manifest has been created. The printable manifest PDF is available for download.

manifestNumbernumber required
documentPdfstring

manifest in format base64 string

Example response

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

Changes