Manifests

Manifest eligible orders

Changed on

Manifest all orders in 'Label Generated' and 'Despatched' statuses and return manifest paperwork where possible.

post/manifests

Request

  • Base URL
    https://api.parcel.royalmail.com/api/v1
  • Auth
    API key in header Authorization

Request body

shippingAccountNamestring

The name of the shipping account to manifest orders for. Required if the account has more than one shipping account. Must match a shippingAccountName returned by GET /carriers.

Example request

{
  "shippingAccountName": "Main Shipping Account"
}

Response

The Manifest all eligible orders request was successful, and a manifest has been created. The Printable PDF manifest is available for download.

manifestNumbernumber required
documentPdfstring

manifest in format base64 string

Example response

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

Changes