Royal Mail · Example Payload

Manifest Orders

Example request and response for manifesting all eligible Royal Mail orders.

ShippingPostal ServicesLabelsTrackingLogisticsBarcodesClick and DropUK

Manifest Orders is an example object payload from Royal Mail, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse_201response_202

Example Payload

Raw ↑ 
{
  "summary": "Manifest eligible orders",
  "description": "Example request and response for manifesting all eligible Royal Mail orders.",
  "request": {
    "carrierName": "Royal Mail OBA"
  },
  "response_201": {
    "manifestNumber": 1001,
    "documentPdf": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZw..."
  },
  "response_202": {
    "manifestNumber": 1002,
    "documentPdf": null
  }
}