Documentation Variables

You can personalise and arrange your documents based on individual items or senders.

Variable

Description

item_type Do we show 1 or multiple item types?
sender_id Internal reference number for the sender company
sender_name Name of the sender company
sender_phone Contact phone number of the sender company
sender_email Contact email address of the sender company
address_origin Concatenated address for the 'origin' of the order.
address_destination Concatenated address for the 'destination' of the order.
contact_origin Concatenated contact details for the 'origin' of the order
contact_destination Concatenated contact details for the 'destination' of the order
address_shipper Address details of the original sender of the order.
contact_shipper Contact details of the original sender company of the order.
transferred_partner_company Company name of the downstream partner assigned to the task
steps_details.pickup.date Date
steps_details.pickup.time Time
steps_details.pickup.address_line_1 Address line 1
steps_details.pickup.address_line_2 Address line 2
steps_details.pickup.country Country
steps_details.pickup.state State
steps_details.pickup.postal_code Postal code
steps_details.pickup.contact_name Contact name
steps_details.pickup.contact_number Contact number
steps_details.pickup.contact_company Company name
steps_details.dropoff.date Date
steps_details.dropoff.time Time
steps_details.dropoff.address_line_1 Address line 1
steps_details.dropoff.address_line_2 Address line 2
steps_details.dropoff.country Country
steps_details.dropoff.state State
steps_details.dropoff.postal_code Postal code
steps_details.dropoff.contact_name Contact name
steps_details.dropoff.contact_number Contact number
steps_details.dropoff.contact_company Company name
item_container.container_no Container number
item_container.iso_type ISO type of the container
item_container.description Description of the container
item_container.seal_no Seal number
item_container.slot_reference Description of the slot
item_container.slot_date Slot date
item_container.tare_weight The tare weight of the container
global_tracking_number Global order tracking number
external_customer_id External customer id 1
external_customer_id2 External customer id 2
external_customer_id3 External customer id 3
tracking_number The tracking number of a given line item
order_tracking_number Tracking number for the order (before or after transfer)
order_external_id External ID
weight Total mass on earth for a given line item
volume Total dimensions for a given line item
dimensions Length, width, and height for a given line item
quantity Number of pieces for a given line item
additional_info Additional information text
company_slug The 'sub-domain' name of the company
logo An image or brandmark of the company
order_item_state The status of the order item
external_order_id_label To retrieve external order id 1 - even if a customs label is applied.
external_item_id_label To retrieve external item id 1 - even if a custom label is applied.
external_item_id2_label To retrieve external item id 2 - even if a customs label is applied.
external_item_id3_label To retrieve external item id 3 - even if a customs label is applied.
vehicle_plate_number Name of the vehicle
vessel_name Name of the vessel
vessel_voyage Voyage number
vessel_departure_port Departure port name
vessel_destination_port Desintation part name