Templates

Template Models

Shipment Template Model

object "shipment__shipping_label_pdf"
The structure for generating shipment shipping label PDFs.

type string
Type of the shipment template, set to "shipment__shipping_label_pdf".

qr_code Object
Information for the QR code on the shipping label.

tracking_number string
The tracking number for the shipment.
order_number string
The order number associated with the shipment.
recipient Object
Details about the recipient of the shipment.
- name string
  The name of the recipient.
- phone_number string
  The phone number of the recipient.
- email string
  The email address of the recipient.
delivery_date string
Estimated delivery date of the shipment.

box_header string
Header for the shipping box label.

box_label_1 string
First label line for the shipping box.

box_label_2 string
Second label line for the shipping box.

barcode string
Barcode for a selected field.

org_logo_url string
URL for the organization's logo to be displayed on the label.

object "item__item_label_pdf"
The structure for generating item label PDFs.

type string
Type of the item template, set to "item__item_label_pdf".

barcode string
Barcode for the item, typically the SKU.

text_line_1 string
First line of text on the item label, usually the item name.

text_line_2 string
Second line of text on the item label, usually the SKU of the item.

text_line_3 string
Third line of text on the item label, usually the GTIN of the item.

dimensions string
Dimensions of the item label, which specify the width and height in inches. Click to expand for details.

Dimensions Details

1x2: A small, vertical label, ideal for smaller items.
1x3: A slightly taller label, providing more space for text.
2x2: A square label, often used for items that require a more balanced design.
2x1: A horizontal label, suitable for items where width is prioritized.
3x1: A long horizontal label, best for labeling larger items with longer text.

org_logo_url string
URL for the organization's logo to be displayed on the item label.

object "asset__asset_label_pdf"
The structure for generating asset label PDFs.

type string
Type of the asset template, set to "asset__asset_label_pdf".

barcode string
Barcode for the asset, typically the asset's serial number.

secondary_barcode string
An additional barcode for the asset, only applicable for 2x2 templates.

text_line_1 string
First line of text on the asset label.

text_line_2 string
Second line of text on the asset label.

text_line_3 string
Third line of text on the asset label.

dimensions string
Dimensions of the asset label, specifying width and height in inches. Click to expand for details.

Dimensions Details

1x2: A small, vertical label for compact assets.
1x3: A taller label offering more space for detailed information.
2x2: A square label, versatile for various asset types.
2x1: A horizontal label, effective for labeling equipment or larger assets.
3x1: A long horizontal label, ideal for wide assets with ample text.
2x2x2: A 2x2 label format designed specifically for assets, includes 2 barcodes.

org_logo_url string
URL for the organization's logo to be displayed on the asset label.