To navigate to the Consignment Report page select Reports in the main menu then select Consignment Report in the drop-down menu.

Report Overview

The Consignment Report is used to generate custom reports on consignment activity, predominantly on recently delivered consignments.  The report is viewable either in the web browser by clicking the Show Report button or by exporting the report into a CSV file by using the Export Excel button. It can also be sent as part of a daily consignment report notification.

The report is customisable and can be saved as a "Report Template" for later use.

Report Filters

1. Customer (Admin Only): Either run the report over all your customers or just for a specific customer.

2. Order By: The order in which the report is sorted.

3. Date Filter: In combination with 4. From and 5. To this is used to filter the report to a specific date range (e.g. all consignments delivered today).

6. Delivery Status: Current status of the consignment (e.g. Awaiting Pickup, In Transit (Pickup → Warehouse), Delivered).

Report Columns

Below are a list and description of all the fields that can be used in this report. For any that are custom fields (".. Custom Fields"), these will show all available custom fields in the report. Each custom field will have a separate header and appear in the order they were set up.

Transport Fields

Field NameDescription
Customer IDThe id of the customer
Customer NameThe name of the customer
Consignment ReferenceThe reference of the consignment
Date DeliveredThe date the consignment was delivered
Consignment Date ModifiedThe date the consignment was last modified.
Consignment IDThe id of the consignment
Consignment IncomeThe income of the consignment
Consignment ExpenseThe expense of the consignment
Consignment Date AddedThe date the consignment was added
Consignment Invoice IDThe id of the consignment invoice
Group Consignment IDThe id of the consignment's group.
Group ConsignmentYes if the consignment is part of a group, else No.
Cash On DeliveryHow much cash on delivery for the consignment.
Consignment ValueThe value of the consignment
Consignment Delivery StatusThe current delivery status of the consignment e.g. Awaiting Pickup
Consignment Custom FieldsAll enabled consignment custom fields. 
Consignment Data Custom FieldsAll enabled consignment data custom fields.
Delivery Run DateThe delivery date of the delivery run.
Delivery RunThe name of the delivery run.
Pickup Company NameThe company name of the consignment's pickup address.
Pickup Street AddressThe street address of the consignment's pickup address.
Pickup SuburbThe suburb of the consignment's pickup address.
Pickup CityThe city of the consignment's pickup address.
Pickup PostcodeThe postcode of the consignment's pickup address.
Pickup StateThe state of the consignment's pickup address.
Delivery Address IDThe id of the consignment's delivery address.
Delivery AddressThe full address of the consignment's delivery address.
Delivery Company NameThe company name of the consignment's delivery address.
Delivery Street AddressThe street address of the consignment's delivery address.
Delivery SuburbThe suburb of the consignment's delivery address.
Delivery CityThe city of the consignment's delivery address.
Delivery PostcodeThe postcode of the consignment's delivery address.
Delivery StateThe state of the consignment's delivery address.
Delivery IDThe delivery id of the consignment
Manifest IDThe manifest id of the consignment
Driver NameThe name of the driver for the consignment
Vehicle NameThe name of the vehicle for the consignment
Mobile App Custom FieldsThe Mobile App Custom Fields. See: Custom Fields within the App

Warehouse Fields

Field NameDescription
Sale Order ReferenceThe reference on the sale order
Sale Order Date addedThe date the sale order was added
Sale Order IDThe id of the sale order
Sale Order Delivery StatusThe current delivery status of the sale order e.g. Awaiting Pick and Pack
Order QtyThe original number of units of a product requested for this sale order
Ship QtyThe number of units of a product that were dispatched with this consignment
Product CodeThe code of the product
Product NameThe name of the product
Product TypeThe type of product
Unit of MeasureThe unit of measure used by the product
Expiry dateThe expiry date of the product
Pop Custom FieldsThe purchase order product custom fields (e.g. Batch Number)

Consignment Notification

It is possible to automatically send daily Consignment Report's to Customers through their notification settings. 

To do this, begin by selecting Contacts in the menu, followed by Customers in the drop-down menu.

Once on the View Customer page select the Customer you wish to set up notifications for.

Then, click Edit.

Under the Email tab and then under the Notifications sub-tab, confirm that Send Daily Consignment Report Email is enabled.

Under the Email tab and then under the Addresses sub-tab either edit an existing notification or add a new email.

Tick the Consignment Notification box and add the desired templates. These templates will be part of the Consignment Notification emails which are sent out daily.

The Report Templates will be sent as an attachment with the name of the attachment used as the Report Template name (so name them wisely!) The attachments are sent as CSV files and contain exactly the same format/columns/data as can be extracted by exporting the report through the web app. One crucial difference is that it does not use both filters, rather it uses whichever filter you selected in the Run Email Notification Over. The options are:

  1. Last Day: This uses the Report Template's saved Date Filter and Delivery Status and runs the report over the last day. For example, if date filter was set to date delivered and the delivery status was all and the date was the 18th then the email sent would contain an attachment with all consignments delivered on the 18th.
  2. Last 3 Months: This uses the Report Template's saved Delivery Status and behaves exactly the same as the first option except it runs the report over the past three months.

Report Templates will not be sent if no consignments match the criteria defined in the template. This is to prevent users from being spammed daily with empty reports. If multiple attachments are supposed to be part of the email and only one has any consignments, just one attachment will be sent.