Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
...
Overview
| Table of Contents |
|---|
Overview
| Excerpt | ||
|---|---|---|
|
Field List
Column Name | Definition | Data Type | Format | Length (max) | ||
|---|---|---|---|---|---|---|
| 1 | TrackingNumber | Consignment Tracking Number | varchar | 50 | ||
| 2 | ConsignmentNumber | Connote Number | varchar | 20 | ||
| 3 | Reference | Consignment primary reference | varchar | 20 | ||
| 4 | StatusDateTime | DateTimestamp of the provider's scan | date | YYYYMMDDhhmmss | - | |
| 5 | ScanEvent | OneFlo Scan Event | varchar | 10 | ||
| 6 | ExtraInfo | Additional Information from Carrier | varchar | 50 | ||
| 7 | Carrier | Carrier or Scan Event Provider | varchar | 50 |
Scan Events
The granularity / detail of scan events depend on the carrier's capability. Some carriers can provide scan events in greater detail compared to others. Some carriers can also provide scan events on an item level.
This table contains a list of fundamental scan events. Carriers configured for your account may provide more or less events than the table below, but this gives a comprehensive life-cycle of a consignment.
Scan Event | Definition |
|---|---|
EDI | EDI Record Downloaded |
DEPOT | Scanned in Depot |
BOOKED IN | Booking Sent To Carrier |
ASN | Advance Shipping Notification |
PICKUP | Pickup Freight |
IN | Into Depot |
TRANS | In Transit |
OBFD | On Board for Delivery |
DEL | Delivered |
COD | Confirmation Of Delivery |
ATL | Authority to Leave (Delivered without Signature) |
POD | Proof of Delivery Available |
CONS | Connote Scanned (Generic scan - see Extra Info) |
CSV Example
| Code Block | ||
|---|---|---|
|
...
"TrackingNumber","ConsignmentNumber","Reference","StatusDateTime","ScanEvent","ExtraInfo","Carrier"
"ALB000002860","ALB000002860","SO-SE2021478","20181024081809","OBFD","Qty:1 of 1@ ABC TAS Pty Ltd","TNT Express"
"AKT000001056","AKT000001056","SO-SE2021659","20181024083139","OBFD","Qty:1 of 1@ Spring vale electrical","TNT Express"
"AKT000001056","AKT000001056","SO-SE2021659","20181024075943","IN"," @ Spring vale electrical","TNT Express"
"AKT000001056","AKT000001056","SO-SE2021659","20181024075941","IN"," @ Spring vale electrical","TNT Express"
"AKT000001258","AKT000001258","SO-SE2020868","20181024081709","DEL","Signed by:RECEIVER Qty:1 of 1 @ RECEIVER","TNT Express"
"AKT000001258","AKT000001258","SO-SE2020868","20181024081605","IN"," @ RECEIVER","TNT Express"
"AKT000001258","AKT000001258","SO-SE2020868","20181024081701","OBFD","Qty:1 of 1@ RECEIVER","TNT Express"
"AKT000001260","AKT000001260","SO-SE2021638","20181024083750","IN"," @ Gotham Electrical and Data C/O","TNT Express"
"AKT000001260","AKT000001260","SO-SE2021638","20181024084642","OBFD","Qty:1 of 1@ Gotham Electrical and Data C/O","TNT Express"
"ALB000002869","ALB000002869","SO-SE2021239","20181024081356","IN"," @ MelbournePty Ltd","TNT Express"
"ALB000002869","ALB000002869","SO-SE2021239","20181024084448","OBFD","Qty:1 of 1@ Melbourne Pty Ltd","TNT Express"
"BGSO0034","BGSO0034","IF-1042944","20181024080200","IN","","Followmont Transport"
"AKT000001265","AKT000001265","IF-1042957","20181024081450","OBFD","Qty:1 of 1 @(ENERGY AWARE PTY LTD)","TNT Express"
"ALB000002865","ALB000002865","PO-SE2007513","20181024075955","OBFD","Qty:1 of 1@ Natural Energy Products","TNT Express"
"CTSOL075","CTSOL075","IF-1042997","20181024101209","BOOKED IN","Pending","Capital Transport (NSW) Pty Ltd"
"CTSOL075","CTSOL075","IF-1042997","20181024101407","ASN","Failed: info@electronics.com.au","Capital Transport (NSW) Pty Ltd"
"CTSOL073","CTSOL073","IF-1042990","20181024093728","BOOKED IN","Pending","Capital Transport (NSW) Pty Ltd"
"CTSOL073","CTSOL073","IF-1042990","20181024094243","ASN","Failed: Johny.Cheng@kookaburra-distribution.com.au","Capital Transport (NSW) Pty Ltd"
"CTSOL074","CTSOL074","SO-SE2021350","20181024093856","BOOKED IN","Pending","Capital Transport (NSW) Pty Ltd"
"CTSOL074","CTSOL074","SO-SE2021350","20181024094305","ASN","Failed: accounts@store.com.au","Capital Transport (NSW) Pty Ltd"
"CTSOL076","CTSOL076","IF-1042992","20181024101630","BOOKED IN","Pending","Capital Transport (NSW) Pty Ltd"
"CTSOL076","CTSOL076","IF-1042992","20181024101928","ASN","Failed: test@kookaburra-distribution.com.au","Capital Transport (NSW) Pty Ltd" |
XML Example
...
Sample_Scan_Report.xml
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="US-ASCII"?>
<Scans>
<ScanEvent>
<TrackingNumber>ALB000002860</TrackingNumber> <!-- typically item level when carrier provides (as printed on barcode) -->
<ConsignmentNumber>ALB000002860</ConsignmentNumber>
<Reference>SO-SE2021478</Reference> <!-- sales order reference from ERP -->
<StatusDateTime>20181024081809</StatusDateTime> <!-- YYYYMMDDhhmmss as per time provided by carrier (time barcode was scanned) -->
<ScanEvent>OBFD</ScanEvent>
<ExtraInfo>Qty:1 of 1@ ABC TAS Pty Ltd</ExtraInfo> <!-- Extra Information as provided by carrier -->
<Carrier>TNT Express</Carrier>
</ScanEvent>
</Scans> |