generate shipment label

This block is part of the shipping group and was last modified in core v14.0.1.

generate shipment label postnlconnection v13.0.9 Updated v14.0.1

This block is used to request the status for a barcode.

In pins 14 + flow

flow
flow
Connection required
postnlconnection
The PostNL connection.
Sender Address required
object
Address of the sender of this shipment. Object should contain the following fields: city, country_code (ISO2), house_number, street, zip_code, house_number_ext.
Receiver Address required
object
Aaddress of the receiver of this shipment. Object should contain the following fields: city, country_code (ISO2), house_number, street, zip_code, house_number_ext.
Shipment dimensions required
object
Dimensions for this shipment. Object should contain weight field. Fields that you can add are: height, width, length, volume. Check the documentation for the units to use for this fields.
Printer Type required
value
Printer type used to print the label. Check documentation for the available types, commonly used Zebra|Generic ZPL II 200 dpi or GraphicFile|GIF 200 dpi
Confirm Shipment required
condition
If this boolean is true the shipment will be automaticly confirmed. If false you need to confirm the shipment with the confirm shipment block.
Receiver information
object
The receiver information for this shipment. Object can contain the following fields: firstname & lastname or company_name, email.
Sender Contact Person
object
Contact person for PostNL for this shipment (from your company). Object should contain the following fields: name or company_name, email.
Product Code Delivery
value
The product code delivery for this shipment. Default value is 3085. Check the documentation for the available codes.
Default 3085
Product Options v14.0.1
array
Array with objects of options, for example [{ "OptionCode": "4", "CharacteristicCode": "191" }]
Customer Order Number
value
A unique order number for this order, max. 35 chars
Your Reference
value
A reference internally used
Collect Reference
value
A reference used when collecting
Barcode
value
If this field is empty an barcode will be generated.

Out pins 6 + flow

flow
flow
Connection
postnlconnection
The PostNL connection
Success
condition
If successful, return true.
Barcode
value
The barcode of the shipment.
Label
object
The data of the label. The object contains this fields: content (Raw label file content), output_type, label_type
Request response
object
The response from PostNL.
Error
value
Error message if the label could not be requested.

A typical wiring for generate shipment label: a function trigger starts the flow; open connection feeds the connection pin; new object feeds the sender_address pin; new object feeds the receiver_address pin; new object feeds the dimensions pin; value feeds the printer_type pin; == feeds the confirm_shipment pin; the flow out pin feeds debug.

Studio canvas example for the generate shipment label block: typical wiring for generate shipment label.

Version history

Introduced in v13.0.9.

Last modified in v14.0.1.

Back to shipping Return to the main group to view all sub-groups Back to PostNL Return to the group to view all blocks within this group

Cluster

Blocks

Interfaces

Blueprints

Tutorials

Home Automation

Examples

Reference

Architecture

Troubleshooting

Other

generate shipment label

Version history