Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 4.1 KB

PrintLabelResponse.md

File metadata and controls

30 lines (27 loc) · 4.1 KB
Raw

PrintLabelResponse

Properties

Name Type Description Notes
shipmentId string Shipment Id<br />Tracking Number or Unique Id of the shipment involved. [optional]
labelImage string Label Image<br />Depends on Label Image Format<br /> <br />PDF<br />Base 64 encoded PDF<br /> <br />PNG<br />Base 64 encoded PNG<br /> <br />ZPL 300 / 203 dpi<br />Base 64 encoded PRN (text file)<br /> <br />Data stream<br />Not Included [optional]
labelImageFormat string Label Image Format [optional]
trackingNumber string Shipment Tracking Number<br />Final Mile carrier tracking number [optional]
uniqueId string Unique Shipment ID [optional]
trackingUrl string Tracking URL<br />Final Mile Tracking, if available [optional]
carrierCode string Carrier Code<br />The allocated carrier. [optional]
primary2DBarcodeImage string Primary 2D Barcode Image<br />Only populated for Data Stream response.<br />Base64 Encoded PNG Image of the 2D data matrix barcode. [optional]
primary2DBarcodeData string Primary 2D Barcode Data - Base 64 Encoded<br />Only populated for Data Stream response.<br />Data required to create your own 2D data matrix barcode. Please decode before use. [optional]
formattedUniqueId string Formatted Unique Id<br />Only populated for Data Stream response.<br />Label for 2D data matrix barcode. [optional]
highVolumeBarcodeData string High Volume Barcode Data<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Data required to create your own High Volume barcode. [optional]
highVolumeBarcodeImage string High Volume Barcode Image<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Base64 Encoded PNG Image of the High Volume barcode. [optional]
highVolumeSortCode string High Volume Sort Code<br />Only populated for Data Stream response where the service requires the sort code on the label. [optional]
primary1DBarcodeData string Primary 1D Barcode Data<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Data required to create your own 1D barcode. [optional]
primary1DBarcodeImage string Primary 1D Barcode Image<br />Only populated for Data Stream response where the service requires the barcode on the label.<br />Base64 Encoded PNG Image of the 1D barcode. [optional]
returnLabelImageFormat string Return Label Image Format [optional]
returnLabelImage string Return Label Image<br />Any return label that have been created as a result of the request and label option settings.<br />Depends on ReturnLabelImageFormat.<br /> <br />PDF<br />Base 64 encoded PDF<br /> <br />PNG<br />Base 64 encoded PNG<br /> <br />ZPL 300 / 203 dpi<br />Base 64 encoded PRN (text file) [optional]
routing \RoyalMail\Shipping\Rest\Api\models\Routing [optional]
httpStatusCode int HTTP Status Code
httpStatusDescription string HTTP Status Description
message string Message<br />Successful response may include a success message.<br />Failure responses will have general reason as to why. Further details may be contained in the list of errors. [optional]
errors \RoyalMail\Shipping\Rest\Api\models\ErrorDetail[] Errors<br />Details about why a request failed. [optional]

[Back to Model list] [Back to API list] [Back to README]