ItemToPrintResponse Structure
Structures of this type can be found in the responses of the getLabels method. They contain binary data of the returned labels. The consignment note and BLP label are returned as PDF documents, the ZBLP label is a text file compatible with Zebra printers. Content of the labels is always encoded in Base64.
Structure Fields
| Field Name | Type | Required? | Description |
|---|---|---|---|
| shipmentId | integer | Yes | Shipment number of the shipment for which a label is prepared. |
| labelType | string | Yes | Dictionary value - one of the following values: LP - shipping label BLP - BLP label in PDF format ZPL - BLP label in format used by Zebra printers |
| labelData | string | Yes | Binary data of the label (encoded in Base64) |
| labelMimeType | string | Yes | MIME type of the label to be sent |
| cn23MimeType | string | Yes (in case of customs clearance) | Customs document type CN23 - returned in the case of simplified customs clearance |
| cn23Data | string | Yes (in case of customs clearance) | Contents of customs document CN23 (base24) - returned in the case of simplified customs clearance |
| fvProformaMimeType | string | Yes (in case of customs clearance) | Proforma invoice document type - returned in the case of simplified customs clearance |
| fvProformaData | string | Yes (in case of customs clearance) | Contents of proforma invoice (base64) - returned in the case of simplified customs clearance |
| fvProformaNumer | string | Yes (in case of customs clearance) | Generated invoice number - if no invoice number is provided in the input parameters |
Example:
<item> <shipmentId>11102224567</shipmentId> <labelType>CN</labelType> <labelName>11102224567.pdf</labelName> <labelData>JVBERi0xLjQKJeLjz9MKNiAwInZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZpZWQgK(...)</labelData> <labelMimeType>application/pdf</labelMimeType> <cn23Data>JVBERi0xLjQKJeLjz9MKNiAwInZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZpZWQgK(...)</cn23Data> <cn23MimeType>application/pdf</cn23MimeType> <fvProformaData>JVBERi0xLjQKJeLjz9MKNiAwInZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZpZWQgK(...)</fvProformaData> <fvProformaMimeType>application/pdf</fvProformaMimeType> </item>