Shipment variables are used for both for documents customized in application settings and for formatting reports using page templates. Using shipments variables for documents customized in application settings is documented here.
For page templates, the shipments variables are available when the following conditions are true:
Shipment ID has been selected as a primary column (it does not work if the Order ID is in a calculated column)
The Shipment ID primary column has a value in the first row following a page break that starts a new report section.
The easiest way to check that the shipment variables will be available in the page template for a report is to export the report to Excel and verify that there is a shipment id in the first row of each sheet in the output.
List of variables for all shipment types
shipment.cancelDate
Formatted cancel date if shipment has been canceled
shipment.shipmentId
Shipment ID
shipment.trackingCode
Tracking number
shipment.shipFromFormatted
Formatted ship from address
shipment.shipToFormatted
Formatted ship to address
shipment.billToFormatted
Formatted bill to address
shipment.shipFromDirections
The ship from directions
shipment.shipToDirections
The ship to directions
shipment.billToDirections
The bill to directions
shipment.telecomNumberFromFormatted
Phone number for the ship from
shipment.telecomNumberToFormatted
Phone number for the ship to
shipment.carrier.groupName
Carrier's name
shipment.carrier.carrierScac
Carrier's SCAC code
shipment.carrier.carrierRegistrationNumber
Carrier's registration number
shipment.carrier.carrierRegistrationHazMatNumber
Carrier's hazmat number
List of variables relating to sale and transfer shipments
shipment.packDate
Formatted pack date if shipment has been packed
shipment.shipDateEstimated
Formatted estimated ship date
shipment.shipDateActual
Formatted ship date if shipment has been shipped
shipment.shipDate
Formatted actual ship date if available, otherwise estimated ship date appended with "(est)"
List of variables relating to sale, transfer, and return shipments
shipment.receiveDateEstimated
Formatted estimated receive date
shipment.receiveDateActual
Formatted receive date if shipment has been shipped
shipment.receiveDate
Formatted actual receive date if available, otherwise estimated receive date appended with "(est)"