Document Template Placeholders

Placeholder (Per Consignment Fields)

Placeholder (Totals)

Description

$CON_ID$

The Consignment ID

$CON_INFO$

Contains "information" such as "GROUP", "PICKUP" and "CONFIRMED" - meaning the consignment was sort confirmed onto the delivery run.

$CON_TYPE_SHORT$

The Consignment Type - PUP or DEL

$CON_REFERENCE$

The consignments reference.

$CUSTOMER_NAME$

The customer name

$CON_ADDRESS$

The complete delivery address formatted into multiple lines

$CON_VALUE$

The Invoice Value of the Consignment

$CON_IS_CASH_ON_DELIVERY$

Whether or not COD is enabled "Yes" or "No"

$CON_CASH_ON_DELIVERY$

The Cash On Delivery Amount

$CON_SPECIAL_INSTRUCTIONS_DELIVERY$

The consignments delivery instructions

$CON_REQUIRED_DELIVERY_DATE$

The consignment Required Delivery Date

$CON_ORDER_ID$

Runsheet sort order

$CONSIGNMENT_STATUS$

Status of the consignment

$DRIVER_NAME$

The Driver name

$VEHICLE_NAME$

The Vehicle name

$RUN_SHEET_NAME$

Run Sheet name.

$CON_DELIVERY_ID$

Delivery address id

$DELIVERY_ADDRESS_COMPANY$

The company name

$DELIVERY_ADDRESS_CONTACT$

The receivers name

$DELIVERY_ADDRESS_STREET$

$DELIVERY_ADDRESS_STREET_2$

The second line of the delivery address (e.g suite, apartment number)

$DELIVERY_ADDRESS_SUBURB$

$DELIVERY_ADDRESS_CITY$

$DELIVERY_ADDRESS_CODE$

$DELIVERY_ADDRESS_STATE$

$DELIVERY_ADDRESS_PHONE$

$DELIVERY_ADDRESS_EMAIL$

$DELIVERY_ADDRESS_LATITUDE$

$DELIVERY_ADDRESS_LONGITUDE$

$DELIVERY_ADDRESS_STARRED$

Whether or not the address is starred

$CON_PICKUP_ID$

The Address Id

$PICKUP_ADDRESS_COMPANY$

The company name

$PICKUP_ADDRESS_CONTACT$

The sender's name

$PICKUP_ADDRESS_STREET$

$PICKUP_ADDRESS_STREET_2$

The second line of the pickup address (e.g suite, apartment number)

$PICKUP_ADDRESS_SUBURB$

$PICKUP_ADDRESS_CITY$

$PICKUP_ADDRESS_CODE$

$PICKUP_ADDRESS_PHONE$

$PICKUP_ADDRESS_EMAIL$

$PICKUP_ADDRESS_LATITUDE$

$PICKUP_ADDRESS_LONGITUDE$

$PICKUP_ADDRESS_STARRED$

Whether or not the address is starred

CON_{MAP_FIELD_NAME}

Custom Fields, such as "Cartons", can be specified here. All Consignment Custom Fields have a "map_field_name". For example:

$CON_CARTONS$
$CON_SPACES$
$CON_WEIGHT$

$CON_SERVICETYPE$

The exact available fields will vary depending on your setup.

Note: Mapped Field name MUST be in UPPER case

SO_DATA

ONFORWARDER ADDRESS

Complete Onforwarder Address

$ONFORWARDER_ADDRESS_COMPANY$

Onforwarder Address company name.

$ONFORWARDER_ADDRESS_STREET$

Onforwarder Address street address.

$ONFORWARDER_ADDRESS_STREET_2$

The second line of the onforwarder address (e.g suite, apartment number)

$ONFORWARDER_ADDRESS_SUBURB$

Onforwarder Address suburb

$ONFORWARDER_ADDRESS_STATE$

Onforwarder Address state

$ONFORWARDER_ADDRESS_CODE$

Onforwarder Address postcode

$ONFORWARDER_ADDRESS_PHONE$

Onforwarder Address phone

$ONFORWARDER_ADDRESS_CONTACT$

Onforwarder Address contact name at the address

$VIA_ONFORWARDER$

If Consignment has onforwarder address will replace tag with string:

'VIA ONFORWARDER'Fcon

CONSIGNMENT ITEM FIELDS:
*If NAME is at the end of the Placeholder the name of the item will appear. For example, $ITEM_WEIGHT_NAME$ may read as 23 kgs.

$ITEM_[uppercase_map_field_name goes here]$

The value of Item Custom Field stored against the Item. The map field name needs to be inserted, (eg BATCH). If your map field name is batch then the replacement tag would be $ITEM_BATCH$

$ITEM_QUANTITY_NAME$

The quantity of the item.

$ITEM_PALLETS_NAME$

The pallets of the item.

$ITEM_CUBIC_NAME$

The cubic of the Item

$ITEM_WEIGHT_NAME$

The weight of the Item

$ITEM_SPACES_NAME$

The spaces of the Item

$ITEM_LENGTH_NAME$

The length of the Item

$ITEM_WIDTH_NAME$

The width of the Item

$ITEM_HEIGHT_NAME$

The height of the Item

$CON_DATA_CF_X_VALUE$

Consignment data custom field

$SO_ID$

ID of associated Sale Order

$AGGREGATE_SOP_PRODUCT_NAME$

Displays the Product Name for aggregated Products

$AGGREGATE_SOP_PRODUCT_DESCRIPTION$

Displays the Product Description for aggregated Products

$AGGREGATE_SOP_PRODUCT_QTY$

Displays the aggregate quantity of Sale Order Products that are aggregated.

$AGGREGATE_SOP_PRODUCT_MEASURE$

Displays the Base Unit of Measure for the aggregated Product.

$AGGREGATE_SOP_PRODUCT_TYPE$

Displays the type of the aggregated product, ie: Frozen, Chilled, Ambient etc.

$AGGREGATE_SOP_PRODUCT_CODE$

Displays the Product Code for aggregated Products.

$PRODUCT_TYPE_NAME$

The product type of the consignment.

$TOTAL_CONSIGNMENTS$

The total number of Consignments

$SUM_VALUE$

The total invoice values all added together.

$TOTAL_CODS$

The total number of CODs

$SUM_COD_VALUE$

All of the COD values added together.

SUM_{MAP_FIELD_NAME}

Totals of the Consignments "Custom Fields" all added together.

$SUM_QUANTITY$
$SUM_PALLETS$
$SUM_WEIGHT$

Sale Order Data

Note, when adding the below Placeholders to your Document Template you must include $BLOCK_SALE_ORDER$ above and below the Sale Order Product Placeholder fields.

Placeholder (Per Consignment Fields)	Placeholder (Totals)	Description
$SOP_CODE$		The Product Code
$SOP_NAME$		The Products Name
$SOP_CUSTOM_FIELD_1$ $SOP_CUSTOM_FIELD_2$ $SOP_CUSTOM_FIELD_3$ ... $SOP_CUSTOM_FIELD_10$		The Purchase Order Products Custom field 1, ie the Batch number (there are 10 custom fields in total)
$SOP_PRODUCT_TYPE$		The type of the product, ie: Frozen, Chilled, Ambient etc.
$SOP_EXPIRY_DATE$		The product expiry date.
$SOP_PRODUCT_STATUS$		The status of the product: "OK", "Quarantine", "Damaged" etc.
$SOP_LOCATION_NAME$		The Warehouse Location Name
$SOP_QTY$		The quantity of the product, always provided in the Base Unit of Measure
$SOP_MEAS$		The Unit Of Measure of the Product, as Base.
$SOP_PRODUCT_CUSTOM_FIELD_1$ ...$SOP_PRODUCT_CUSTOM_FIELD_10$		The Products Custom Field 1, ie: Supplier Code (there are 10 custom fields in total)

Document Template Placeholders - Run Sheet