CSV uploads for consignments

You can upload consignment data to NowGo using a CSV file. This article discusses the various fields you can use to provide consignment information into NowGo using CSV.

You can also download an example CSV file.

Field types

There are two different field types that you can use:

General fields: used for setting parcel and other general data
Consignment party fields: used for setting sender and receiver, and address and location data

General fields

General fields are used for setting parcel data, along with a range of other information. These fields do not accept a prefix.

The article identifiers are highly recommended, as these make the consignments scannable in the NowGo mobile app. This allows drivers to scan the label to pick up and drop off the consignment.

This table shows the available general fields:

Field name	Example	Description	Required?
`ext_ref` OR `external_reference`	`abcd_1001`	External reference for the consignment	Optional
`consignment_identifiers` OR `consignment_identifier`	`1000ABCD` or for multiple `1000ABCD, 1000A`	Consignment barcode	Optional
`article_identifiers` OR `article_identifier`	`1000ABCD` or for multiple `1000ABCD, 1000A`	Article barcode	Recommended
`receiver_day_of_time_window_start`	11:11	If configured, when this article is onboarded and a stop is created, this is the start of the time window.	Optional
`receiver_day_of_time_window_end`	22:22	If configured, when this article is onboarded and a stop is created, this is the end of the time window.	Optional
`custom_data`	`{ "field": "value" }`	Custom data for consignment	Optional
`comms_plan_id`	`42`	The ID of the communications plan	Optional
`comms_plan_ext_ref`	`test_plan`	The external reference of the communications plan	Optional

Consignment party fields

Nested fields are used for setting the consignment parties, such as the sender and receiver. These fields expect a valid prefix.

Valid prefixes

You must nest consignment party fields with a prefix. The valid prefixes are:

sender
receiver

An example of using a nested field:

sender.business_name | receiver.address_line_1

ACME Pty Ltd | 100 Example Road

This table shows the available consignment party fields:

Field name	Example	Description
`name`	sender.name ACME Products	Name of the entity
`is_business`	receiver.is_business True	A boolean specifying if this entity is a business.
`business_name`	sender.business_name ACME Pty Ltd	Name of the business
`email`	receiver.email [email protected]	Email address
`address_line_1`	sender.address_line_1 100 Example Road	Address line one
`address_line_2`	receiver.address_line_2 Example Apartments	Address line two
`address_line_3`		Address line three
`address_line_4`		Address line four
`address_line_5`		Address line five
`locality`	sender.locality Exampletown	Suburb, township, or city
`state`	receiver.state New South Wales	State
`postal_code`	sender.postal_code 2000	Postcode
`contact_name`	receiver.contact_name Jane Example	Contact name
`contact_phone`	sender.contact_phone 0400100200	Contact phone number
`latitude`	receiver.latitude 33° 51' 30" S	Latitude
`longitude`	sender.longitude 151° 12' 53" E	Longitude
`custom_data`		Custom data

consignment-sample.csv

Showing dynamic information in communications

Display custom data on the NowGo Dashboard

Consignment CSV Template

Create customer communications

Completing a stop in the mobile app