Page tree
Skip to end of metadata
Go to start of metadata

Proof Of Delivery Template

PlaceholderDescription
$ORGANISATION_NAME$The name of your company
$COMPANY_NAME$The name of your customer
$REFERENCE$The Reference Number for the consignment
$BARCODE$The Barcode Number of the consignment
$DATE_ADDED$The date the Consignment was added to the system
$PICKUP_ADDRESS$The Picking Address for the Consignment
$DELIVERY_ADDRESS$The Delivery Address for the Consignment
$SPECIAL_INSTRUCTIONS$The Special Instructions
$CONSIGNMENT_QUANTITY$An aggregation of all your Consignment Fields, and the Consignment Value, for example:
Cartons: 5 | Pallets: 3 | Ties: 0 | Value: $156.10
$DRIVER$Name of driver on runsheet associated to the consignment.
$VEHICLE$Name of vehicle on runsheet associated to the consignment.
$MANIFEST_CUSTOMER_REFERENCE$Customer reference on the Consignment's manifest. Blank if no manifest is attached.
$CONSIGNMENT_TYPE$Type of Consignment, eg; Delivery, Pickup, etc
$REQUIRED_DELIVERY_DATE$Required date of delivery of the Consignment. If no date is specified this will default to 'ASAP'
$ON_FORWARDER_ADDRESS$The On Forwarder Address for the Consignment, if one is specified.
$ON_FORWARDER_NAME$The Contact Name specified in the On Forwarder Address for the Consignment, if one is specified.
$CARRIER_NAME$Name of the Carrier attached to this Consignment.

$FIELD_1$

...

$FIELD_30$

The configured name for the Custom Field on the Consignment. Numbered 1 through to 30.

$FIELD_1_VAL$

...

$FIELD_30_VAL$

The value set for this Custom Field on this Consignment. Numbered 1 through to 30.

$DATA_CUSTOM_FIELD_1$

...

$DATA_CUSTOM_FIELD_10$

The configured name for this Data Custom Field on the Consignment. Numbered 1 through to 10.

$DATA_CUSTOM_FIELD_1_VAL$

...

$DATA_CUSTOM_FIELD_10_VAL$

The value set for this Data Custom Field on this Consignment. Numbered 1 through to 10.
Sale Order Product Fields:

If the Consignment was generated from a Sale Order, then you can make it show the associated Sale Order Product fields:

PlaceholderDescription
$SOP_CODE$The Product Code
$SOP_NAME$The Products Name
$SOP_CUSTOM_FIELD_1$The Purchase Order Products Custom field 1, ie the Batch number
$SOP_CUSTOM_FIELD_2$
$SOP_CUSTOM_FIELD_3$
... $SOP_CUSTOM_FIELD_10$(there are 10 custom fields in total)
$SOP_PRODUCT_TYPE$The type of the product, ie: Frozen, Chilled, Ambient etc.
$SOP_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$The Products Custom Field 1, ie: Supplier Code
...$SOP_PRODUCT_CUSTOM_FIELD_10$(1, 2 ... 10)


Sale Order Delivery Document Template

PlaceholderDescription
$ID$The ID of the Sale Order
$COMPANY_NAME$The name of the Customer
$PICK_DATE$The date the picking completed
$REFERENCE$The Reference for the Sale Order
$ADDRESS$The Delivery Address for the Sale Order
$TELEPHONE$The Delivery Addresses Telephone Number
$PACKING_INSTRUCTIONS$The Packing Instructions
$DELIVERY_INSTRUCTIONS$The Delivery Instructions
$ORGANISATION_NAME$The name of your company, ie: "Roving Logistics".
$CONSIGNMENT_ID$The ID of the Consignment linked to the Sale Order
$CONSIGNMENT_REFERENCE$The Reference of the Consignment linked to the Sale Order
$CONSIGNMENT_DELIVERY_RUN_NAME$The name of the Delivery Run that the Consignment linked to the Sale Order is allocated to
$REQUIRED_SHIP_DATE$Required Ship Date from Sale Order - as specified
$REQUIRED_DELIVERY_DATE$Required Delivery Date from Sale Order
$EXPECTED_DELIVERY_RUN_DATE$The expected date the Sale Order would be shipped from the warehouse. This gets automatically calculated if no $REQUIRED_SHIP_DATE$ is provided upon Sale Order creation.
$EXPECTED_DELIVERY_RUN$The expected Delivery Run name that the Sale Order would be on
$CASH_ON_DELIVERY$Displays either Yes or No depending on whether or not the Sale Order is using Cash On Delivery (COD)
$ATTACH_INVOICE_TO_GOODS$Displays either Yes or No depending on whether or not the Sale Order requires a Customer Invoice to be attached to the goods
$ORDER_URGENT$Displays either Yes or No depending on whether or not the Sale Order is urgent
$SALE_ORDER_CUSTOM_FIELD_1_NAME$Displays the name of Sale Order Custom Field 1. To show the name of Custom Field 2 you would use $SALE_ORDER_CUSTOM_FIELD_2_NAME$
$SALE_ORDER_CUSTOM_FIELD_10_NAME$There are up to 10 Sale Order Custom Field names that can be shown in the template
$SALE_ORDER_CUSTOM_FIELD_1_VALUE$Displays the value of Sale Order Custom Field 1. To show the value of Custom Field 2 you would use $SALE_ORDER_CUSTOM_FIELD_2_VALUE$
$SALE_ORDER_CUSTOM_FIELD_10_VALUE$There are up to 10 Sale Order Custom Field values that can be shown on the template
$CONSIGNMENT_CUSTOM_FIELD_1_NAME$Displays the name of the Associated Consignment Custom Field 1. To show the name of Custom Field 2 you would use $CONSIGNMENT_CUSTOM_FIELD_2_NAME$
$CONSIGNMENT_CUSTOM_FIELD_30_NAME$There are up to 30 Associated Consignment Custom Field names that can be shown in the template
$CONSIGNMENT_CUSTOM_FIELD_1_QTY$Displays the value of the Associated Consignment Custom Field 1. To show the value of Custom Field 2 you would use $CONSIGNMENT_CUSTOM_FIELD_2_QTY$
$CONSIGNMENT_CUSTOM_FIELD_30_QTY$There are up to 30 Associated Consignment Custom Field values that can be shown in the template
PRODUCT FIELDS:
PlaceholderDescription
$CODE$The Product Code
$NAME$The Products Name
$CUSTOM_FIELD_1$The Purchase Order Products Custom field 1, ie the Batch number
$CUSTOM_FIELD_2$
$CUSTOM_FIELD_3$
... $CUSTOM_FIELD_10$(there are 10 custom fields in total)
$PRODUCT_TYPE$The type of the product, ie: Frozen, Chilled, Ambient etc.
$EXPIRY_DATE$
$PRODUCT_STATUS$The status of the product: "OK", "Quarantine", "Damaged" etc.
$LOCATION_NAME$The Warehouse Location Name
$QTY$The quantity of the product, always provided in the Base Unit of Measure
$MEAS$The Unit Of Measure of the Product, as Base.
$PRODUCT_WEIGHT$The Weight for each product.
$PRODUCT_CUSTOM_FIELD_1$The Products Custom Field 1, ie: Supplier Code
...$PRODUCT_CUSTOM_FIELD_10$(1, 2 ... 10)

Products within the Sale Order Delivery

Consignment Note Document Template

PlaceholderDescription
$ID$The system generated ID of the Consignment
$ORGANISATION_NAME$Your organisation name in CartonCloud
$COMPANY_NAME$The name of the Customer that the Consignment is for
$REFERENCE$The customer reference of the Consignment
$BARCODE$The barcode number of the Consignment
$DATE_ADDED$The date the Consignment was added to CartonCloud
$PICKUP_ADDRESS$The pickup address of the Consignment
$DELIVERY_ADDRESS$The delivery address of the Consignment
$DELIVERY_RUN_NAME$The name of the Delivery Run that the Consignment is assigned to
$DELIVERY_RUN_DATE$The date the Consignment will be delivered
$SPECIAL_INSTRUCTIONS$The special instructions for the Consignment
$COD_VALUE$The Cash On Delivery value of the Consignment if applicable
$PRODUCT_TYPE$The Product Type that the Consignment is for
$DATE$The current date
$FROM_COMPANY$The sending Company of the Consignment
$FROM_STREET$The street address of the sending Company
$FROM_STATE$The state of the sending Company
$FROM_CODE$The postcode of the sending Company
$FROM_PHONE$The Phone number of the sending Company
$TO_COMPANY$The receiving Company of the Consignment
$TO_STREET$The street address of the receiving Company
$TO_STATE$The state of the receiving Company
$TO_CODE$The postcode of the receiving Company
$TO_PHONE$The Phone number of the receiving Company
$FIELD_1$The field name of Consignment Custom Field 1. (eg Cartons). To show Custom Field 2 you would use $FIELD_2$. (this would show Pallets for example). There are up to 30 Consignment custom fields that can be shown on the template if the fields have been created
$FIELD_1_VAL$The value of Consignment Custom Field 1 (eg the number of cartons on the Consignment). To show the value of Custom Field 2 you would use $FIELD_2_VAL$. This would show value of pallets for example. There are up to 30 Consignment custom fields that can be shown on the template if the fields have been created.
$DATA_FIELD_[uppercase_map_field_name goes here]$The field name of Consignment Data Custom Field. The map field name needs to be inserted, (eg WEIGHT). If your map field name is weight. Any spaces in the map field name will be replaced with no space, for example a map field of: "kg weight" should be loaded in here as KGWEIGHT. Ie: $DATA_FIELD_KGWEIGHT$
$DATA_FIELD_[uppercase_map_field_name goes here]_VAL$The field value of Consignment Data Custom Field. (eg WEIGHT). If your map field name is WEIGHT. If your map field name is weight. Any spaces in the map field name will be replaced with no space, for example a map field of: "kg weight" should be loaded in here as KGWEIGHT. Ie: $DATA_FIELD_KGWEIGHT_VAL$
$SOP_CUSTOM_FIELD_1$Custom Fields from Sale Order products, e.g. Custom Field 1 could be Batch for example. Whatever has been added to the customer Purchase Order Products for these custom fields.
Use SOP_CUSTOM_FIELD_2 for next field etc etc. 
$DRIVER$Name of driver on runsheet associated to the consignment.
$VEHICLE$Name of vehicle on runsheet associated to the consignment.
$REQUIRED_SHIP_DATE$Required Ship date from Associated Sale Order
$CONSIGNMENT_REQUIRED_DELIVERY_DATE$Required Delivery Date from Consignment
$SALEORDER_REQUIRED_DELIVERY_DATE$Required Delivery Date from Associated Sale Order
$SALE_ORDER_URGENT$Displays either a Yes or No depending on whether the Associated Sale Order is urgent
$ATTACH_INVOICE_TO_GOODS$Displays either a Yes or No depending on whether the Associated Sale Order requires a Customer Invoice to be attached to the goods
$SALE_ORDER_CUSTOM_FIELD_1_NAME$Displays the name of Associated Sale Order Custom Field 1. To show the name of Custom Field 2 you would use $SALE_ORDER_CUSTOM_FIELD_2_NAME$
$SALE_ORDER_CUSTOM_FIELD_10_NAME$There are up to 10 Associated Sale Order Custom Field names that can be shown in the template
$SALE_ORDER_CUSTOM_FIELD_1_VALUE$Displays the value of Associated Sale Order Custom Field 1. To show the value of Custom Field 2 you would use $SALE_ORDER_CUSTOM_FIELD_2_VALUE$
$SALE_ORDER_CUSTOM_FIELD_10_VALUE$There are up to 10 Associated Sale Order Custom Field values that can be shown on the template
PRODUCT FIELDS:

Values of Products from Associated SaleOrder

PlaceholderDescription
$SOP_CODE$The Product Code
$SOP_NAME$The Products Name
$SOP_CUSTOM_FIELD_1$The Purchase Order Products Custom field 1, ie the Batch number
$SOP_CUSTOM_FIELD_2$
$SOP_CUSTOM_FIELD_3$
... $CUSTOM_FIELD_10$(there are 10 custom fields in total)
$SOP_PRODUCT_TYPE$The type of the product, ie: Frozen, Chilled, Ambient etc.
$SOP_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_WEIGHT$The Weight for each product.
$PRODUCT_CUSTOM_FIELD_1$The Products Custom Field 1, ie: Supplier Code
...$PRODUCT_CUSTOM_FIELD_10$(1, 2 ... 10)

Run Sheet Template

PlaceholderDescription
Per-Consignment Fields
$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.
$CON_CUSTOMER$The customer name
$CON_ADDRESS$The complete delivery address formatted into multiple lines
$CON_VALUE$The Invoice Value of the Consignment
$CON_COD$Whether or not COD is enabled "Yes" or "No"
$CON_COD_VALUE$The Cash On Delivery Amount
$CON_INSTRUCTIONS$The consignments delivery instructions
$DRIVER_NAME$The Driver name
$VEHICLE$The Vehicle name
CON_DELIVERY_

All of these fields are related to the Delivery Address.

$CON_DELIVERY_ID$The Address Id
$CON_DELIVERY_ADDRESS_COMPANY_NAME$The company name
$CON_DELIVERY_CONTACT_NAME$The receivers name
$CON_DELIVERY_STREET_ADDRESS$
$CON_DELIVERY_SUBURB$
$CON_DELIVERY_CITY$
$CON_DELIVERY_POSTCODE$
$CON_DELIVERY_TELEPHONE$
$CON_DELIVERY_EMAIL$
$CON_DELIVERY_LATITUDE$
$CON_DELIVERY_LONGITUDE$
$CON_DELIVERY_STARRED$Whether or not the address is starred
CON_PICKUP_

All of these fields are related to the Pickup Address.

$CON_PICKUP_ID$The Address Id
$CON_PICKUP_ADDRESS_COMPANY_NAME$The company name
$CON_PICKUP_CONTACT_NAME$The senders name
$CON_PICKUP_STREET_ADDRESS$
$CON_PICKUP_SUBURB$
$CON_PICKUP_CITY$
$CON_PICKUP_POSTCODE$
$CON_PICKUP_TELEPHONE$
$CON_PICKUP_EMAIL$
$CON_PICKUP_LATITUDE$
$CON_PICKUP_LONGITUDE$
$CON_PICKUP_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$

Exact available fields will vary depending on your setup.

SO_DATA

Displays information about the Sale Order Products contained within the Consignment. (in the case where the Consignment has come from a Sale Order).

For example:

2 x Gherkins 150gm
3 x Dice (12 x 12-sided)

Totals
$TOTAL_CONSIGNMENTS$The total number of Consignments
$SUM_VALUE$The total invoice values all added together.
$TOTAL_CODS$The total number of CODs on the
$SUM_COD_VALUE$All of the COD values added together.
SUM_{MAP_FIELD_NAME}

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

$SUM_CARTONS$
$SUM_PALLETS$
$SUM_WEIGHT$

Sales Order Pack List Template

PlaceholderDescription
$ID$The ID of the Sale Order
$COMPANY_NAME$The name of the Customer
$PACK_STATUS$The current status of the Sale Order
$SUM_VALUE$The value assigned to the Sale Order if any
$CUSTOMER_REFERENCE$The Reference for the Sale Order
$DELIVERY_ADDRESS$The Delivery Address for the Sale Order
$TODAY_DATE$The date the Pack List was printed
$PACKING_INSTRUCTION$The Packing Instructions for the Sale Order
$DELIVERY_INSTRUCTION$The Delivery Instructions for the Sale Order
$BLOCK_INSTRUCTION$Used as a template block replace. If you have an instructions section that you want to hide if there are no instructions then put this tag above and below the section to hide. It will get cleaned up if no Packing or Delivery instructions are on the Sale Order. If there are instructions then this text will get cleaned up and the relevant instructions and other content will be displayed
$CHARGE_NAME$Used for displaying any Adhoc Charge field names. Used in conjunction with $BLOCK_ADHOC_CHARGE$ tags
$BLOCK_ADHOC_CHARGE$Used as a template block replace. If you have any Sale Order Adhoc Charges configured to show on the Pack List page then they will appear where these tags wrap a section of the template and the $CHARGE_NAME$ tag is used within. If there are no Sale Order Adhoc Charges, then these tags and any content they wrap will be cleaned up and won't appear
$POP_FIELD_HEADING_1$The heading of the linked POP custom field 1. Used in conjunction with $POP_FIELD_VALUE_1$ for showing the corresponding field value
...$POP_FIELD_HEADING_10$(1, 2 ... 10) for the above
PRODUCT FIELDS:
PlaceholderDescription
$CODE$The Product Code
$NAME$The Products Name
$COMPANY_NAME$The name of the Customer that the Product belongs to
$LOCATION_NAME$The name of the Warehouse Location that the Sale Order Product is being picked from
$EXPIRY_DATE$The expiry date of the linked POP if applicable
$PRODUCT_TYPE$The type of the product, ie: Frozen, Chilled, Ambient etc.
$PRODUCT_STATUS$The status of the product: "OK", "Quarantine", "Damaged" etc.
$QTY$The quantity of the product, always provided in the Base Unit of Measure
$MEAS$The Unit Of Measure of the Product, as Base.
$PO_REFERENCE$The Reference of the Purchase Order that the POP that the Sale Order Product is taking stock from
$POP_FIELD_VALUE_1$The Purchase Order Product's Custom Field 1, eg: Batch Number
...$POP_FIELD_VALUE_10$(1, 2 ... 10) for the above

N.B. you must change the Default Sale Order Pack List Format to allow Default PDF Format located in Org Settings>Warehouse>Sales Orders Configurations

Purchase Order Product (POP) Label

PlaceholderDescription
$ID$The ID of the POP that the label is being printed for
$CUSTOMER_NAME$The name of the Customer that the POP belongs to
$LOCATION_NAME$The name of the Warehouse Location that the POP is allocated to if any
$EXPIRY_DATE$The Expiry Date of the POP
$PRODUCT_NAME$The name of the Product that the POP is made of
$PRODUCT_CODE$The code of the Product that the POP is made of
$PRODUCT_BARCODE$The barcode of the Product that the POP is made of
$QTY$The Onhand quantity of the POP
$MEAS$The Product Unit of Measure of the Product the POP is made of
$PRODUCT_TYPE_NAME$The name of the Product Type that the POP is made of
$PRODUCT_TYPE_CODE$The code of the Product Type that the POP is made of
$PRODUCT_STATUS$The status of the Product that the POP is made of
$PO_REFERENCE$The Reference of the Purchase Order that the POP belongs to
$POP_LABEL_ID$The barcode number used in scanning POPs. Consists of a prefix and the POP ID
$HEADER_VAL_1$The heading of the POP custom field. Used in conjunction with $FIELD_VAL_1$ for showing the corresponding POP custom field value
...$HEADER_VAL_10$(1, 2 ... 10) for the above
$FIELD_VAL_1$The POP custom field value for the given field (eg. the Batch Number if you had a field heading Batch Number)
...$FIELD_VAL_10$(1, 2 ... 10) for the above
$PO_HEADER_1$The heading of the Purchase Order custom field. Used in conjunction with $PO_VALUE_1$ for showing the corresponding Purchase Order custom field value
...$PO_HEADER_10$(1, 2 ... 10) for the above
$PO_VALUE_1$The Purchase Order value for the given custom field
...$PO_VALUE_10$(1, 2 ... 10) for the above

Consignment Label Template

PlaceholderDescription
$ID$The system generated ID of the Consignment
$ORGANISATION_NAME$Your organisation name in CartonCloud
$ORGANISATION_WEBSITE$Your organisation website in CartonCloud
$ORGANISATION_PHONE$Your organisation telephone in CartonCloud
$COMPANY_NAME$The name of the Customer that the Consignment is for
$REFERENCE$The customer reference of the Consignment
$BARCODE$The barcode number of the Consignment
$DATE_ADDED$The date the Consignment was added to CartonCloud
$PICKUP_ADDRESS$The pickup address of the Consignment
$DELIVERY_ADDRESS$The delivery address of the Consignment
$ON_FORWARDER_ADDRESS$The on forwarder address of the Consignment
$DELIVERY_RUN_NAME$The name of the Delivery Run that the Consignment is assigned to
$DELIVERY_RUN_DATE$The date the Consignment will be delivered
$SPECIAL_INSTRUCTIONS$The special instructions for the Consignment
$MANIFEST_ID$The Manifest ID
$COD_VALUE$The Cash On Delivery value of the Consignment if applicable
$PRODUCT_CODE$The Product Code that the Consignment is for
$PRODUCT_TYPE$The Product Type that the Consignment is for
$DATE$The current date
$FROM_COMPANY$The sending Company of the Consignment
$FROM_STREET$The street address of the sending Company
$FROM_STATE$The state of the sending Company
$FROM_CODE$The postcode of the sending Company
$FROM_PHONE$The Phone number of the sending Company
$TO_COMPANY$The receiving Company of the Consignment
$TO_STREET$The street address of the receiving Company
$TO_STATE$The state of the receiving Company
$TO_CODE$The postcode of the receiving Company
$TO_PHONE$The Phone number of the receiving Company
$ON_FORWARDER_COMPANY$
$ON_FORWARDER_STREET$
$ON_FORWARDER_STATE$
$ON_FORWARDER_CODE$
$ON_FORWARDER_PHONE$
$FIELD_#$The field name of Consignment Custom Field 1. (eg Cartons). To show Custom Field 2 you would use $FIELD_2$. (this would show Pallets for example). There are up to 30 Consignment custom fields that can be shown on the template if the fields have been created
$FIELD_#_VAL$The value of Consignment Custom Field 1 (eg the number of cartons on the Consignment). To show the value of Custom Field 2 you would use $FIELD_2_VAL$. This would show value of pallets for example. There are up to 30 Consignment custom fields that can be shown on the template if the fields have been created.
$DATA_FIELD_[uppercase_map_field_name goes here]$The field name of Consignment Data Custom Field. The map field name needs to be inserted, (eg WEIGHT). If your map field name is weight. Any spaces in the map field name will be replaced with no space, for example a map field of: "kg weight" should be loaded in here as KGWEIGHT. Ie: $DATA_FIELD_KGWEIGHT$
$DATA_FIELD_[uppercase_map_field_name goes here]_VAL$The field value of Consignment Data Custom Field. (eg WEIGHT). If your map field name is WEIGHT. If your map field name is weight. Any spaces in the map field name will be replaced with no space, for example a map field of: "kg weight" should be loaded in here as KGWEIGHT. Ie: $DATA_FIELD_KGWEIGHT_VAL$
$SOP_CUSTOM_FIELD_#$Custom Fields from Sale Order products, e.g. Custom Field 1 could be Batch for example. Whatever has been added to the customer Purchase Order Products for these custom fields.
Use SOP_CUSTOM_FIELD_2 for next field etc etc. 
$DRIVER$Name of driver on runsheet associated to the consignment.
$VEHICLE$Name of vehicle on runsheet associated to the consignment.
$REQUIRED_SHIP_DATE$Required Ship date from Associated Sale Order
$CONSIGNMENT_REQUIRED_DELIVERY_DATE$Required Delivery Date from Consignment
$SALE_ORDER_REQUIRED_DELIVERY_DATE$Required Delivery Date from Associated Sale Order
$SALE_ORDER_ID$The ID of the Associated Sale Order
$SALE_ORDER_URGENT$Displays either a Yes or No depending on whether the Associated Sale Order is urgent
$SALE_ORDER_REFERENCE$The customer reference of the Associated Sale Order
$ATTACH_INVOICE_TO_GOODS$Displays either a Yes or No depending on whether the Associated Sale Order requires a Customer Invoice to be attached to the goods
$SALE_ORDER_CUSTOM_FIELD_1_NAME$Displays the name of Associated Sale Order Custom Field 1. To show the name of Custom Field 2 you would use $SALE_ORDER_CUSTOM_FIELD_2_NAME$
$SALE_ORDER_CUSTOM_FIELD_10_NAME$There are up to 10 Associated Sale Order Custom Field names that can be shown in the template
$SALE_ORDER_CUSTOM_FIELD_1_VALUE$Displays the value of Associated Sale Order Custom Field 1. To show the value of Custom Field 2 you would use $SALE_ORDER_CUSTOM_FIELD_2_VALUE$
$SALE_ORDER_CUSTOM_FIELD_10_VALUE$There are up to 10 Associated Sale Order Custom Field values that can be shown on the template


PDF Templates

To add or modify a barcode that will appear on the label you will need to follow the below instructions.

  1. Select the QR Code Image in the default template, if you are adding a second barcode copy and paste this image and position it on the label where you wish to print it.

  2. Right Click on the new image or if you wish to change what the current barcode relates to right click on that image and select "Edit Alt Text"

  3. Enter the field name you wish to represent in the barcode followed by a colon then select from the three barcode formats below e.g. $Product_Barcode:BC128$
  4. Save the document, then upload as per normal. 


Barcode Suffixes

  • BC39
  • BC128
  • QRCODE

ZPL Templates

Getting Started with ZPL Code

In order to draw text on your label, you need to create a "field", e.g. ^FDProduct Name:^FS.

The field contains only the visible text (Product Name), and is preceded by configuration commands. Let's take a look at this code:

Example ZPL Code
^XA
^FO 15,15
^A 0,N,45,45
^FDProduct Name:^FS
^XZ

The tags below explain the label configuration commands:

TagDescription
^XAStart of the label. Mandatory.
^FO x,y

Field Origin. Sets the top-left corner of the invisible box containing the text.

x - horizontal portion of the coordinate.

y - vertical portion of the coordinate

e.g. ^FO30,15 corresponds to a point 15 down and 30 across from the top-left corner of the label.

A fo,h,w

Sets the font for the following field.

f - "name" of the font (accepts values a-z or 0-9). (limited ZPL accepted fonts)

o - orientation of the text. (accepts N=normal, I=Inverted, D=inverted and reversed, R=reversed)

h - height of the text.

w - character width of the text.

e.g. A0N,45,45 sets the text to font 0, Normal orientation, height 45, width 45.

^FD data

Field Data. Used at the beginning of the line to indicate the printable the characters.

data - text to printed on the label (e.g. Product Name)

^FSField Separator. Used at the end of the line to indicate the end of the printable characters.
^XZEnd of the label. Mandatory.

For more information and a list of available commands, you can find the ZPL command documentation here. There is also a ZPL viewer at labelary.com, and they have a more concise list of available commands available here.



Modifiers

There are some modifiers which are specific to ZPL templates:

ModifierExampleNotes
REVERSE
$PRODUCT_TYPE_NAME:REVERSE$

"General" becomes "lareneG"

Reverses the value for right-aligned text.

SUFFIX
$HEADER_VAL_1:SUFFIX" - "$

"Batch Number" becomes "Batch Number - "

Adds the given text to the end of the value.
PREFIX
$HEADER_VAL _1:PREFIX"> "$

"Batch Number" becomes "> Batch Number"

Adds the given text to the start of the value.
BC39
$POP_LABEL_ID:BC39$
Draws a code 39 barcode.
BC128$POP_LABEL_ID:BC128$Draws a code 128 barcode.



Sale Order Label PDF

PlaceholderDescription
$PAGE$

This is the page number of the current page. Useful when used with $PAGES$ for when there is multiple copies and you want the total number of labels to be visible.

eg: $PAGE$ of $PAGES$ with 3 copies would produce the following on each page in the output:

1 of 3

2 of 3

3 of 3

$PAGES$The total number of copies of the label being printed.
$SALE_ORDER_ID$ID of the Sale Order
$BARCODE_ID$Barcode version of the Sale Order ID, rendered as SO{Sale Order ID}, eg: SO123
$SALE_ORDER_REF$Customer reference on the Sale Order
$CUSTOMER_NAME$Name of the Customer associated with the Sale Order
$ADDRESS_COMPANY_NAME$Company name set on the Address of the Sale Order
$ADDRESS_CONTACT_NAME$Contact name set on the Address of the Sale Order
$ADDRESS_SUBURB$Suburb of the Address of the Sale Order
$ADDRESS_CITY$City of the Address of the Sale Order
$ADDRESS_STREET$Street address of the Address of the Sale Order
$ADDRESS_POSTCODE$Postcode of the Address of the Sale Order
$ADDRESS_STATE$National State of the Address of the Sale Order
$TENANT_NAME$Name of the current Tenancy
$TENANT_WEBSITE$Website configured in the Organisation Settings of the current Tenancy
$TENANT_PHONE$Phone number configured in the Organisation Settings of the current Tenancy
$DELIVERY_RUN_NAME$Name of the Delivery Run
$EXPECTED_DELIVERY_RUN_NAME$Name of the expected Delivery Run
$REQUIRED_DELIVERY_DATE$Required date of delivery of the Consignment
$EXPECTED_DELIVERY_RUN_DATE$Expected delivery run date of the Consignment
$REQUIRED_SHIP_DATE$Required ship date of the Consignment
SuffixDescription
BC39

Creates a BC39 Barcode of the placeholder and attempts to replace the placeholder image(s) that have alt text that matches the full token.

eg: A QR Code of the Sale Order Refernce: $SALE_ORDER_REF:BC39$

BC128

Creates a BC128 Type B Barcode of the placeholder and attempts to replace the placeholder image(s) that have alt text that matches the full token.

eg: A QR Code of the Sale Order Refernce: $SALE_ORDER_REF:BC128$

QRCODE

Creates a QR Code of the placeholder and attempts to replace the placeholder image(s) that have alt text that matches the full token.

eg: A QR Code of the Sale Order Refernce: $SALE_ORDER_REF:QRCODE$




  • No labels