Consignment CSV Template

Column name

Maps to

Notes

sender.business_name

sender

sender.address_line_1

sender.address_line_2

sender.locality

sender.state

sender.postal_code

sender.contact_name

sender.contact_phone

sender.latitude

sender.longitude

sender.custom_data.*

sender.custom_data

Can be many of these columns.

If the value parses as JSON, use that. Otherwise, take it as a string.

receiver.business_name

receiver

receiver.address_line_1

receiver.address_line_2

receiver.locality

receiver.state

receiver.postal_code

receiver.contact_name

receiver.contact_phone

receiver.latitude

receiver.longitude

receiver.custom_data.*

receiver.custom_data

Can be many of these columns.

If the value parses as JSON, use that. Otherwise, take it as a string.

custom_data.*

custom_data

Can be many of these columns.

If the value parses as JSON, use that. Otherwise, take it as a string.

priority_id or priority_ext_ref

priority

We should check validity client-side and error if it’s not acceptable.

identifiers or barcodes

Will create a single-article consignment, with multiple article identifiers.

article_identifiers or article_barcodes

Multiple article ids should be added in the same cell using a , (Eg. article1, article2, article3)

comms_plan_id or comms_plan_ext_ref

comms_plan

Will start a single comms plan session matching your id or ext_ref, if its valid. Check the ext_ref field in the Comms Plan dashboard pages.