ROroyalmail
Labels

Return a single PDF file with generated label and/or associated document(s)

Changed on

<b>Reserved for OBA customers only</b>

The account "Label format" settings page will control the page format settings used to print the postage label and associated documents. Certain combinations of these settings may prevent associated documents from being printed together with the postage label within a single document. If this occurs the documentType option can be used in a separate call to print missing documents.

get/orders/{orderIdentifiers}/label

Request

  • Base URL
    https://api.parcel.royalmail.com/api/v1
  • URL
    https://api.parcel.royalmail.com/api/v1/orders/{orderIdentifiers}/label
  • Auth
    API key in header Authorization

Path parameters

orderIdentifiersstring required

One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.

Query parameters

documentType'postageLabel' | 'despatchNote' | 'CN22' | 'CN23' | 'commercialInvoice' required

Document generation mode. When documentType is set to "postageLabel" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to "postageLabel". When documentType is set to "commercialInvoice" the includeCommercialInvoice parameter applies.

includeReturnsLabelboolean

Include returns label. Required when documentType is set to 'postageLabel'

includeCNboolean

Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the "Label format" setting "Generate customs declarations with orders"

includeCommercialInvoiceboolean

Includes the commercial invoice with the label. Only applies when documentType is "commercialInvoice".

Response

Return the PDF file with labels

string binary required

Changes