Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

...

Table of Contents

Overview

Excerpt
Tip

Consignment Level Data provides an excellent overview of freight being dispatched and costs incurred. An Excellent resource to integrate into your ERP/WMS, OR to use manually to perform reports and analysis to break down costs and assign them internally.

Receive the all the data we can offer and decide what is right for you. making future development as easy as possible ensuring you always have all your consignment information as stored in your Dispatch platform.

Field List

Field

Definition

Data Type

Format

Length (max)

1

Connote

Consignment Tracking Number

...

text

20

2

Released

Consignment Release date

date 

YYYY-MM-DD

-

3

Reference

Primary consignment reference

...

text

20

4

Service

Carrier Service (as defined in OneFlo)

...

text

10

5

Carrier

Carrier Name (as defined in OneFlo)

...

text

50

6

CostCenter

Cost Centre (as defined in OneFlo) - use OneFlo for best results

text

50

7

Third Party Reference

Third Party Account provided in OneFlo

text

50

8

Sender

Sender Name

...

text

50

...

9

SAddress1

Sender Address Line 1

...

text

30

...

10

SAddress2

Sender Address Line 2

...

text

30

...

11

SLocality

Sender Locality / Suburb

text

...

BRISBANE CITY

50

...

12

SState

Sender State

text

...

QLD

5

...

13

SPCode

Sender Postcode

text

...

4000

10

...

14

Receiver

Receiver Name

...

text

50

...

15

RAddress1

Receiver Address Line 1

...

text

30

...

16

RAddress2

Receiver Address Line 2

...

text

30

...

17

RLocality

Receiver Locality / Suburb

text

...

MELBOURNE

50

...

18

RState

Receiver State

text

...

VIC

5

...

19

RPCode

Receiver Postcode

text

...

3000

10

...

20

Items

Total number of Items

int

-

...

21

Weight

Total Weight

float

-

...

22

Volume

Total volume

float

-

...

23

Time

Total Time (if captured)

float

-

...

24

Distance

Total Distance (if captured)

float

-

...

25

ZoneFrom

Carrier Zone From

...

text

10

...

26

ZoneTo

Carrier Zone To

...

text

10

...

27

Freight

Basic Freight Charge

money

-

...

28

Fees

Fees Charge

money

-

...

29

Net

Net Charge

money

-

...

30

GST

Tax

money

-

...

31

Total

Total Freight Charge (Freight+Fees+GST)

money

-

...

32

UserField1

User defined field #1

...

text

20

...

33

UserField2

User defined field #2

...

text

20

...

34

UserField3

User defined field #3

...

text

20

...

35

UserField4

User defined field #4

...

text

20

...

36

UserField5

User defined field #5

...

text

20

...

Available Formats

...

  1. Useful for basic consignment level reporting
  2. Readable in Spreadsheet applications such as Microsoft Excel
  3. Human friendly

...

37

SUs

List of Shipping Units (packages/containers)

stsructured

Code Block
<SU>
        <ItemNo>1</ItemNo>
        <Reference>3180553</Reference>
		<PackageType>CTN</PackageType> <!-- see https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type for a full list -->
        <Type>CA0030</Type>
        <Weight>21</Weight>
        <Length>40</Length>
        <Width>26</Width>
        <Height>26</Height>
        <Volume>0.027</Volume>
        <Barcode>VCAL009168001</Barcode>
        <Description>Carton Standard</Description>
        <ItemID>VCAL009168001</ItemID>
</SU>

38

References

Additional References

structured

<Reference>ref1</Reference>

<Reference>…</Reference>

<Reference>refX</Reference>

Alternatively in CSV format these can be pipe delimited

39

ConCatRefs

Additional References (Legacy view)

comma-delimited

varchar

"ref1,ref2,ref3"

...

40

ETA

Consignment ETA date

date 

YYYY-MM-DD

-

XML Structure

This is the standard OneFlo XML Postback structure. We recommend using this as it will have all available dataset against the consignment. It will be up to your system to pick and choose which elements of the consignment element will be imported.

Note

You may download a sample from the Available Formats section to develop your import mechanism.

Code Block
<?xml version="1.0" encoding="us-ascii"?>
<Consignments>
  <Consignment>
    <Connote>VCAL009168</Connote>
    <Consigned>2019-03-04T00:00:00+11:00</Consigned>
    <Released>2019-03-04T00:00:00+11:00</Released>
	<Carrier>Border Express Transport</Carrier>
    <Service>BBEP</Service>
    <Reference>3180553</Reference>
    <Sender>KOALA AUSTRALIA PTY LTD</Sender>
    <SAddress1>22 Kangaroo Drive</SAddress1>
    <SAddress2>
    </SAddress2>
    <SLocality>DANDENONG SOUTH</SLocality>
    <SState>VIC</SState>
    <SPcode>3175</SPcode>
    <SCountryCode>AU</SCountryCode>
    <SCountry>AUSTRALIA</SCountry>
    <SContact>DESPATCH, KOALA</SContact>
    <SPhone>0312345678</SPhone>
    <SEmail>Despatch@KOALA.com</SEmail>
    <SenderLocation>DANDENONG SOUTH VIC 3175</SenderLocation>
    <Receiver>FROG GROUP PTY LTD</Receiver>
    <RAddress1>10 WHALE AVENUE</RAddress1>
    <RAddress2>
    </RAddress2>
    <RLocality>BLACKTOWN</RLocality>
    <RState>NSW</RState>
    <RPcode>2148</RPcode>
    <RCountryCode>AU</RCountryCode>
    <RCountry>AUSTRALIA</RCountry>
    <RContact>EMMA OKEEFFE</RContact>
    <RPhone>
    </RPhone>
    <ReceiverLocation>BLACKTOWN NSW 2148</ReceiverLocation>
    <Description>
    </Description>
    <DeliveryInstructions>
    </DeliveryInstructions>
    <SpecialInstructions>
    </SpecialInstructions>
    <Items>2</Items>
    <Weight>44</Weight>
    <Volume>0.054</Volume>
    <Distance>0</Distance>
    <Hours>0</Hours>
    <FreightCharge>18.0000</FreightCharge>
    <FreightFeesCharge>2.4300</FreightFeesCharge>
    <NetCharge>20.4300</NetCharge>
    <TaxCharge>2.0400</TaxCharge>
    <TotalCharge>22.4700</TotalCharge>
    <ConCatRefs> 3180553</ConCatRefs>
    <ETA>2019-03-05T00:00:00+11:00</ETA>
    <SUs>
      <SU>
        <ItemNo>1</ItemNo>
        <Reference>3180553</Reference>
		<PackageType>CTN</PackageType> <!-- see https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type for a full list -->
        <Type>CA0030</Type>
        <Weight>21</Weight>
        <Length>40</Length>
        <Width>26</Width>
        <Height>26</Height>
        <Volume>0.027</Volume>
        <Barcode>VCAL009168001</Barcode>
        <Description>Carton Standard</Description>
        <ItemID>VCAL009168001</ItemID>
      </SU>
      <SU>
        <ItemNo>2</ItemNo>
        <Reference>3180553</Reference>
		<PackageType>CTN</PackageType> <!-- see https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type for a full list -->
        <Type>CA0030</Type>
        <Weight>23</Weight>
        <Length>40</Length>
        <Width>26</Width>
        <Height>26</Height>
        <Volume>0.027</Volume>
        <Barcode>VCAL009168002</Barcode>
        <Description>Carton Standard</Description>
        <ItemID>VCAL009168002</ItemID>
      </SU>
    </SUs>
  </Consignment>
</Consignments>

Available Formats

Type

Advantages

Sample

XML

  1. Robust data structure

  2. Easily imported into ERP or WMS or vital systems relevant for freight reporting

View file
nameSample_Postback_Full.xml

CSV

  1. Useful for basic consignment level reporting

  2. Readable in Spreadsheet applications such as Microsoft Excel

  3. Human friendly

View file
nameCustomer_Daily_20180815190020.csv