Sign in

v2

latestSwagger 2.02026-07-31155351.0 KB
Manifests

Manifest eligible orders

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

post/manifests

Request body

carrierNamestring

The name of the carrier you would like to manifest orders for. This is required if the account has multiple carriers or multiple postage location numbers, and must match the name configured in the carrier settings within the main website.

Example request

{
  "carrierName": "Royal Mail OBA"
}

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"
}