ItemToPrint Structure

This structure defines a label type, which can be downloaded by the user using the getLabels method.

Structure Fields

Field Name Type Required? Description
labelType string Yes Dictionary value - one of the following values:
LP - shipping label
BLP - BLP label,
LBLP - BLP label in A4 PDF format,
ZBLP - BLP label in format used by Zebra printers,
ZBLP300 - BLP 300dpi label in format used by Zebra printers If you use a laser printer – label generated in PDF file – BLP parameter
If you use a Zebra thermal printer - label generated in zpl file – ZBLP or ZBLP300 parameter QR_PDF - QR code in PDF format for ZK shipment
QR2_IMG - QR code in PNG format with dimensions 2cm x 2cm for ZK shipment
QR4_IMG - QR code in PNG format with dimensions 4cm x 4cm for ZK shipment
QR6_IMG - QR code in PNG format with dimensions 6cm x 6cm for ZK shipment
shipmentId integer Yes Shipment number of the shipment for which a label is to be downloaded

Example:

<itemToPrint>
    <labelType>ZBLP</labelType>
    <shipmentId>11102224567</shipmentId>
</itemToPrint>
Go back to topic list