Versions Compared

Key

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

Overview

OneFlo is capable of accepting an XML EDI file that must contain the following information:

  1. Shipper

  2. Carrier

  3. Consignment

    1. Details (Consignment level item count, weight, volume)

    2. Sender

    3. Receiver

    4. Package details (individual item dims, weight, volume, DG information)

Data Specifications

...

Field Name

...

Type

...

Len

...

Mandatory

...

Comment

...

Generated

...

Text

...

30

...

Status
colourRed
titleY

...

Application

...

Text

...

30

...

Status
colourRed
titleY

...

Name of your Application

...

Version

...

Text

...

20

...

DistributorId

...

Numeric

...

10

...

Status
colourRed
titleY

...

EFM Distributor

...

Shipper >

...

AddressType 

...

1

...

   Id

...

Numeric

...

Status
colourRed
titleY

...

Must be an account number provided by efm (ItemId)

...

   Name

...

Text

...

30

...

   Address1

...

Text

...

30

...

   Address2

...

Text

...

30

...

   Locality

...

Text

...

30

...

   State

...

Text

...

3

...

   Postcode

...

Text

...

4

...

Carrier > Account

...

Numeric

...

Status
colourRed
titleY

...

Must be an account number provided by efm

...

Consignment >

...

Consignment

...

*

...

Status
colourRed
titleY

...

Multiple

...

   Account

...

Numeric

...

Status
colourRed
titleY

...

Must be an account number provided by efm

...

   Connote

...

Text

...

20

...

Status
colourRed
titleY

...

Tracking Number (used by carrier to provide tracking events to efm)

...

   Consigned

...

DateTime

...

Status
colourRed
titleY

...

Date/Time consignment was created.

...

   Released

...

DateTime

...

Status
colourRed
titleY

...

Date/Time consignment was released/manifested/finalised.

...

   SRT

...

Text

...

1

...

Status
colourRed
titleY

...

Freight movement:

S = Outbound, 

R = Returns, 

T = Transfer Movement (3rd party)

...

   CarrierAccount

...

Text

...

20

...

If the consignment involves a third-party or receiver paying, this must contain the carrier account of charged entity.
This must adhere to the payor's charge entity registered on the prescribed carrier.

...

   Service

...

Text

...

20

...

Status
colourRed
titleY

...

Carrier Service Provided by efm

...

   ATL

...

Bool

...

Authority to Leave Flag { True | False }

...

   References

...

Text

...

20

...

Status
colourRed
titleY

...

Reference numbers. Allows multiple instances.

Consolidated consignments, for example, may contain multiple references in the form:
<Reference>PO0001</Reference>
<Reference>PO0002</Reference>

...

   CostCentre

...

Text

...

20

...

Optional field for some senders

...

   Sender >

...

AddressType

...

30

...

Status
colourRed
titleY

...

      Name

...

Text

...

30

...

Status
colourRed
titleY

...

      Address1

...

Text

...

30

...

Status
colourRed
titleY

...

      Address2

...

Text

...

30

...

      Locality

...

Text

...

30

...

Status
colourRed
titleY

...

      State

...

Text

...

3

...

Status
colourRed
titleY

...

      Postcode

...

Text

...

4

...

Status
colourRed
titleY

...

      Contact

...

Text

...

20

...

      Phone

...

Text

...

15

...

      Email

...

Text

...

50

...

   Receiver >

...

AddressType

...

30

...

Status
colourRed
titleY

...

    Name

...

Text

...

30

...

Status
colourRed
titleY

...

      Address1

...

Text

...

30

...

Status
colourRed
titleY

...

      Address2

...

Text

...

30

...

      Locality

...

Text

...

30

...

Status
colourRed
titleY

...

      State

...

Text

...

3

...

Status
colourRed
titleY

...

      Postcode

...

Text

...

4

...

Status
colourRed
titleY

...

      Contact

...

Text

...

20

...

      Phone

...

Text

...

15

...

      Email

...

Text

...

50

...

   Items

...

Numeric

...

Status
colourRed
titleY

...

Total Number of SUs for the consignment

...

   Weight

...

Numeric

...

Status
colourRed
titleY

...

Weight in Kgs. Up to 2 decimal places.

...

   Cubage

...

Numeric

...

Status
colourRed
titleY

...

Cubic metres (m3). Up to 3 decimal places.

...

   Description

...

Text

...

40

...

   Special Instructions

...

Text

...

60

...

   Delivery Instructions

...

Text

...

60

...

   UserField1

...

Text

...

50

...

   UserField2

...

Text

...

50

...

   UserField3

...

Text

...

50

...

   UserField4

...

Text

...

50

...

   UserField5

...

Text

...

50

...

   Package >

...

PackageType

...

*

...

Status
colourRed
titleY

...

Defines the Shipping Unit

...

      Type

...

Text

...

20

...

Status
colourRed
titleY

...

Warehouse specific code to determine a package type (different from PackagingType defined later)

This could be any code to identify within the warehouse (i.e. SMLCTN for small cartons, or SAT1KG for a 1 kg Satchel).

...

      Number

...

Numeric

...

Status
colourRed
titleY

...

The index (starting 1) or otherwise known as ordinal integer.

e.g. if there are 3 packages, this will enumerate package 1, package 2, and package 3

...

      Reference

...

Text

...

20

...

Recommended for consolidated consignments.
If you're consignment contains multiple references, it's best to highlighed individual items associated to which order reference.

...

      Description

...

Text

...

40

...

      Weight

...

Numeric

...

Status
colourRed
titleY

...

Weight of SU in Kgs. Up to 2 decimal places.

...

      Cubic

...

Numeric

...

Status
colourRed
titleY

...

Cubic metres (m3). Up to 3 decimal places.

...

      Length

...

Numeric

...

Status
colourRed
titleY

...

Length in centimetres (cm). Up to 2 decimal places.

...

      Width

...

Numeric

...

Status
colourRed
titleY

...

Length in centimetres (cm). Up to 2 decimal places.

...

      Height

...

Numeric

...

Status
colourRed
titleY

...

Length in centimetres (cm). Up to 2 decimal places.

...

      PackType

...

Text

...

Status
colourRed
titleY

...

Code for the OneFlo defined packaging type: See Shipping Items - Packaging Type

...

      Barcode

...

Text

...

50

...

Status
colourRed
titleY

...

Scannable barcode (Unique per shipping unit!) as printed on label

...

      PalletInfo >

...

PalletInfoType

...

*

...

If PackageType is Pallet, please provide pallet info

...

         Type

...

Text

...

10

...

LOSCAM, CHEP, PLAIN

...

         Count

...

int

...

Number of pallets of this type

...

      DG >

...

DGType

...

*

...

         UN

...

Numeric

...

4

...

Status
colourRed
titleY

...

UN Number for the Dangerous Goods

...

         Class

...

Text

...

10

...

Status
colourRed
titleY

...

Classification of DG

...

         SubRisk

...

Text

...

20

...

Subsidiary hazard code

...

         Group

...

Text

...

10

...

Packing group (e.g. I , II, III ) or leave blank

...

         ProperShippingName

...

Text

...

100

...

Status
colourRed
titleY

...

Identifiable DG name as specified in the code

...

         CommonName

...

Text

...

100

...

Status
colourRed
titleY

...

Nickname for the DG

...

         Qty

...

Numeric

...

Status
colourRed
titleY

...

Amount of DGs within the receptacle in the shipment 
(e.g. If there are 4 aerosol cans in this shipping unit, put 4 in this field)

...

         AggQty

...

Numeric

...

Status
colourRed
titleY

...

Amount of DG in Unit
(e.g if there are 4 aerosol cans that are 300 ml each, the value placed in this field must be 300 ml x 4 cans = 1.2 L)

...

         Units

...

Text

...

10

...

Status
colourRed
titleY

...

Unit used in the AggQty (kg or L)

...

         Receptacle

...

Text

...

50

...

Status
colourRed
titleY

...

Container for the DG (e.g. can, tank, box, bottle)

XML Structure

XML
Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<EDI ManifestId="1" xmlns="http://www.opensys.com.au/schema/SCaRRS/1.1">
  <Generated>
    <Application>3PL_APPLICATION</Application> <!-- Place name of Application i.e. <3PL_SYSTEM>  -->
    <Version>VERSION</Version> <!-- Please input version of Application -->
    <Created>MANIFESTDATE</Created> <!-- Include date of Manifest. Not mandatory -->
    <DistributorId>101605</DistributorId> <!-- efm Logistics Services -->
  </Generated>
  <Shipper>
    <Id>XXXXXX</Id> <!-- <Customer> ACCOUNT 6 digit number, will be provided-->
    <Company>CUSTOMER NAME</Company> <!-- <Customer> trading name-->
    <AddressLine1>ADDRESS LINE 1</AddressLine1>
    <AddressLine2>ADDRESS LINE 2</AddressLine2>
    <Locality>LOCALITY</Locality>
    <State>STATE</State>
    <Postcode>POSTCODE</Postcode>
    <CountryCode>AU</CountryCode> <!-- 2 Character Country Code-->
    <Country>AUSTRALIA</Country>
    <Contact />
    <Phone />
    <Fax />
    <Email />
  </Shipper>
  <Carrier>
    <Id>Couriers Please Pty Ltd</Id>
    <Account>102959</Account> <!-- <Carrier> 6 digit ID, will be provided by efm-->
  </Carrier>
  <Consignment>
    <Account>XXXXXX</Account> <!-- <Customer> ACCOUNT 6 digit number, will be provided by efm-->
    <Connote>CON00000000001</Connote>
    <Consigned>2018-06-18T00:00:00</Consigned> <!-- Date of Consignment -->
    <Released>2018-06-18T00:00:00</Released> <!-- Date of Release -->
    <DeliverOn />
    <Service>CPPCL</Service> <!-- Carrier Service – Must be the Service code provided by efm -->
    <CarrierAccount /> <!-- Carrier Charge account (when third party pays) -->
    <Reference>PO001234</Reference>
    <CostCenter/> <!-- optional -->
    <SRT>S</SRT> <!-- Freight movement, see options above -->
    <Sender>
      <Company>Sender Name</Company>
      <AddressLine>SENDER ADDRESS LINE 1</AddressLine>
      <AddressLine />
      <Locality>LOCALITY</Locality>
      <State>STATE</State>
      <Postcode>POSTCODE</Postcode>
      <CountryCode>AU</CountryCode> <!-- 2 Character Country Code-->
      <Country>AUSTRALIA</Country>
      <Contact />
      <Phone />
      <Fax />
      <Email />
    </Sender>
    <Receiver>
      <Company>Receiver Name</Company>
      <AddressLine>RECEIVER ADDRESS LINE 1</AddressLine>
      <AddressLine />
      <Locality>LOCALITY</Locality>
      <State>STATE</State>
      <Postcode>POSTCODE</Postcode>
      <CountryCode>AU</CountryCode> <!-- 2 Character Country Code-->
      <Country>AUSTRALIA</Country>
      <Contact />
      <Phone />
      <Fax />
      <Email />
    </Receiver>
    <Items>2</Items>
    <Weight>7</Weight>
	<Cubic>.12</Cubic>
    <Instructions />
    <SpecialInstructions />
    <Description />
    <GoodsValue>0.0000</GoodsValue>
    <InsuranceClass />
    <DutyTaxesPaid>False</DutyTaxesPaid>
    <CustomsClearanceRequired>False</CustomsClearanceRequired>
    <UserField1 />
    <UserField2 />
    <UserField3 />
    <UserField4 />
    <UserField5 />
    <Package Type="ITEM"> <!-- Your Shipping Unit type e.g. CARTON, PALLET, SKID, etc -->
      <Id>XXXXXXXXXXXXXXX1</Id>
      <Number>1</Number> <!-- Ordinal number in reference to each consignment -->
      <Reference /> <!-- Order reference for this shipping item -->
      <Description>CARTON</Description>
      <Weight>4.13</Weight>
      <Cubic>.047</Cubic>
      <Length>10</Length>
      <Width>10</Width>
      <Height>10</Height>
      <PackType>CTN</PackType>  <!-- Must adhere to https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type -->
      <Barcode>XXXXXXXXXXXXXXX1</Barcode> <!-- must be the actual barcode / sscc that is scannable on the label -->
    </Package>
    <Package Type="ITEM"> <!-- Your Shipping Unit type e.g. CARTON, PALLET, SKID, etc -->
      <Id>XXXXXXXXXXXXXXX2</Id>
      <Number>2</Number>
      <Reference />
      <Description>CARTON</Description>
      <Weight>4.13</Weight>
      <Cubic>.047</Cubic>
      <Length>10</Length>
      <Width>10</Width>
      <Height>10</Height>
      <PackType>CTN</PackType> 
      <Barcode>XXXXXXXXXXXXXXX2</Barcode> <!-- must be the actual barcode / sscc that is scannable on the label -->
      <DG> <!-- Must follow ADG Code https://www.ntc.gov.au/heavy-vehicles/safety/australian-dangerous-goods-code/  -->
        <UN>3090</UN>
        <Class>9</Class>
        <SubRisk>N/A</SubRisk>
        <Group></Group>
        <ProperShippingName>LITHIUM METAL BATTERIES CONTAINED IN EQUIPMENT</ProperShippingName>
        <CommonName>LITHIUM BATTERIES</CommonName>
        <Qty>1</Qty>
        <AggQty>1</AggQty>
        <Units>kg</Units>
        <Receptacle>BOX</Receptacle>
      </DG>
    </Package>
  </Consignment>
  <Consignment>
     ...
  </Consignment>
</EDI>

Customisation

...

OneFlo EDI Capabilities

OneFlo can seamlessly process your electronic data interchange (EDI) documents to streamline your supply chain. We accept XML EDI files containing the following information:

  • The Shipper and Carrier details

  • The Shipment Information: Consignment details Sender, and Receiver details including level item count, weight, and volume

  • The Package details: Individual item specifications such as dimensions (DIMs), weight, volume, and dangerous goods (DG) information

Data Specifications

Mandatory indicator '*'

EDI

Field Name

Comment

Carrier*

Carrier node required

Consignment*

At less 1 Consignment node is required can be repeated per consignment record

Generated*

Generated node required

Shipper*

Shipper node required

Carrier node

Field Name

Comment

AddressLine1

30 characters limits

AddressLine2

30 characters limits

Company

The company trading name

Contact

The contact name

Country

30 characters limits

CountryCode

2 characters limits e.g. AU or NZ

Email

Fax

Numeric value only

Id*

10 numeric limits, There are two ways to provide the Carrier Id value:

  1. You can use a 6-digit ID provided by efm.

  2. You can find the value from the carrierID key of the response payload when you use the POST /{accountId}/quotes endpoint.

Locality

30 characters limits

Phone

Numeric value only

Postcode

4 numeric limits

State

3 characters limits

Consignment node

Field Name

Comment

AccountId*

10 numeric limits need to be set to the 6-digit ID provided by efm

ATL

true or false

ATLCode

If ATL=true and the carrier is StarTrack then an ATLCode is required

CarrierAccount

The carrier charge account (when third party pays)

Connote*

20 characters limits

Consigned*

The date of Consignment

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

ContainerId

CostCenter

Cubic*

CustomsClearanceRequired

true or false

DeliverOn

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

DeliveryDateFrom

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

DeliveryDateTo

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

DeliveryTimeFrom

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

DeliveryTimeTo

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

Description

DutyTaxesPaid

true or false

GoodsValue

Instructions

InsuranceClass

Items*

Numeric value only

Package*

At less 1 Package node is required can be repeated per package record

  • Package need an attribute Type that equal to your Sender packaging code e.g. 5KGCARTON, PALLET, SKID, etc… e.g. Type=“ITEM“

Receiver*

Receiver node required

Reference*

Released*

The date of Release

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

Sender*

Sender node required

Service*

There are two ways to provide the Service value:

  1. The service code provided by efm.

  2. You can find the value from the service key of the response payload when you use either the POST /{accountId}/quotes or GET /{accountId}/services endpoints.

SpecialInstructions

SRT*

either S = Outbound, R = Return, T = Transfer

UserField1

UserField2

UserField3

UserField4

UserField5

Weight*

Generated node

Field Name

Comment

Application*

30 characters limits should be the name of Application i.e. <OneFlo>

CreatedAt

Datetime ISO 8601 format YYYY-MM-DDTHH:MM:SS

DistributorId*

10 numeric limits need to be set to efm distributor ID and it is provided by efm

Version

30 characters limits the version of Application

Shipper node

Field Name

Comment

AddressLine1

30 characters limits

AddressLine2

30 characters limits

Company

The company trading name

Contact

The contact name

Country

30 characters limits

CountryCode

2 characters limits e.g. “AU” or “NZ”

Email

Fax

Numeric value only

Id*

Maximum 10 numeric value need to be set to the 6-digit ID provided by efm

Locality

30 characters limits

Phone

Numeric value only

Postcode

4 numeric limits

State

3 characters limits

Sender node

Field Name

Comment

AddressLine1*

30 characters limits

AddressLine2

30 characters limits

Company*

The company trading name

Contact

The contact name

Country

30 characters limits

CountryCode

2 characters limits e.g. “AU” or “NZ”

Email

Fax

Numeric value only

Locality*

30 characters limits

Phone

Numeric value only

Postcode*

4 numeric limits

State*

3 characters limits

Receiver node

Field Name

Comment

AddressLine1*

30 characters limits

AddressLine2

30 characters limits

Company*

The company trading name

Contact

The contact name

Country

30 characters limits

CountryCode

2 characters limits e.g. “AU” or “NZ”

Email

Fax

Numeric value only

Locality*

30 characters limits

Phone

Numeric value only

Postcode*

4 numeric limits

State*

3 characters limits

Package node

Field Name

Comment

Barcode*

Must be the actual barcode / sscc that is scannable on the label

Cubic*

Description

DG

DG node if declare then must follow ADG Code https://www.ntc.gov.au/heavy-vehicles/safety/australian-dangerous-goods-code

Height*

Id

Length*

Number*

PackType*

OneFlo Packaging code accepted value are; [BAG, CGE, CTN, CRT, DRM, LEN, PLT, SAT, SKD,OTH]

For further details refer to Shipping Items - Packaging Type

Reference

Weight*

Width*

DG node

Field Name

Comment

AggQty*

Class*

CommonName*

Group

ProperShippingName*

Qty*

Receptacle*

SubRisk

UN*

Units*

Expand
titleSample Structure
Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<EDI xmlns="http://www.opensys.com.au/schema/SCaRRS/1.1" ManifestId="1">
	<Carrier>
		<AddressLine1>133 Foundation Road</AddressLine1>
		<AddressLine2/>
		<Company>Couriers Please Pty Ltd</Company>
		<Contact/>
		<Country>AUSTRALIA</Country>
		<CountryCode>AU</CountryCode>
		<Email/>
		<Fax/>
		<Id>123456</Id>
		<Locality>Truganina</Locality>
		<Phone/>
		<Postcode>3029</Postcode>
		<State>VIC</State>
	</Carrier>
	<Consignment>
		<AccountId>123456</AccountId>
		<ATL>false</ATL>
		<ATLCode/>
		<CarrierAccount/>
		<Connote>CON00000000001</Connote>
		<Consigned>2018-06-18T00:00:00</Consigned>
		<ContainerId/>
		<CostCenter/>
		<Cubic>0.5</Cubic>
		<CustomsClearanceRequired>false</CustomsClearanceRequired>
		<DeliverOn/>
		<DeliveryDateFrom/>
		<DeliveryDateTo/>
		<DeliveryTimeFrom/>
		<DeliveryTimeTo/>
		<Description/>
		<DutyTaxesPaid>false</DutyTaxesPaid>
		<GoodsValue>0.0000</GoodsValue>
		<Instructions/>
		<InsuranceClass/>
		<Items>2</Items>
		<Package Type="ITEM">
			<Barcode>XXXXXXXXXXXXXXX1</Barcode>
			<Cubic>.047</Cubic>
			<Description>CARTON</Description>
			<Height>10</Height>
			<Id>XXXXXXXXXXXXXXX1</Id>
			<Length>10</Length>
			<Number>1</Number>
			<PackType>CTN</PackType>
			<Reference/>
			<Weight>4.13</Weight>
			<Width>10</Width>
		</Package>
		<Package Type="ITEM">
			<Barcode>XXXXXXXXXXXXXXX2</Barcode>
			<Cubic>.047</Cubic>
			<Description>CARTON</Description>
			<DG>
				<AggQty>1</AggQty>
				<Class>9</Class>
				<CommonName>LITHIUM BATTERIES</CommonName>
				<Group>NONE</Group>
				<ProperShippingName> LITHIUM METAL BATTERIES CONTAINED IN
EQUIPMENT</ProperShippingName>
				<Qty>1</Qty>
				<Receptacle>BOX</Receptacle>
				<SubRisk>N/A</SubRisk>
				<UN>3090</UN>
				<Units>kg</Units>
			</DG>
			<Height>10</Height>
			<Id>XXXXXXXXXXXXXXX2</Id>
			<Length>10</Length>
			<Number>2</Number>
			<PackType>CTN</PackType>
			<Reference/>
			<Weight>4.13</Weight>
			<Width>10</Width>
		</Package>
		<Receiver>
			<AddressLine1>Receiver Address</AddressLine1>
			<AddressLine2/>
			<Company>Receiver Company Name</Company>
			<Contact>Receiver Contact Name</Contact>
			<Country>AUSTRALIA</Country>
			<CountryCode>AU</CountryCode>
			<Email>receiver@email.com</Email>
			<Fax/>
			<Locality>SUBURB</Locality>
			<Phone/>
			<Postcode>4854</Postcode>
			<State>QLD</State>
		</Receiver>
		<Reference/>
		<Released>2018-06-18T00:00:00</Released>
		<Sender>
			<AddressLine1>Sender Address</AddressLine1>
			<AddressLine2/>
			<Company>Sender Name</Company>
			<Contact/>
			<Country>AUSTRALIA</Country>
			<CountryCode>AU</CountryCode>
			<Email/>
			<Fax/>
			<Locality>SUBURB</Locality>
			<Phone/>
			<Postcode>3192</Postcode>
			<State>VIC</State>
		</Sender>
		<Service>CPPCL</Service>
		<SpecialInstructions/>
		<SRT>S</SRT>
		<UserField1/>
		<UserField2/>
		<UserField3/>
		<UserField4/>
		<UserField5/>
		<Weight>7</Weight>
	</Consignment>
	<Generated>
		<Application>OneFlo</Application>
		<CreatedAt>YYYY-MM-DDTHH:MM:SS</CreatedAt>
		<DistributorId>101605</DistributorId>
		<Version>1</Version>
	</Generated>
	<Shipper>
		<AddressLine1>39 Marshall Court</AddressLine1>
		<AddressLine2/>
		<Company>efm warehousing</Company>
		<Contact>Doe, John</Contact>
		<Country>AUSTRALIA</Country>
		<CountryCode>AU</CountryCode>
		<Email>john.doe@efmlogistics.com.au</Email>
		<Fax/>
		<Id>123456</Id>
		<Locality>Altona</Locality>
		<Phone>61411222333</Phone>
		<Postcode>3018</Postcode>
		<State>VIC</State>
	</Shipper>
</EDI>

Customization Options

While we currently support a selection of recognized EDI formats, OneFlo can potentially customize the system to handle other formats upon request. However, customization may incur additional costs and require business approval. Please contact your IT Solutions consultant to inquire about compatibility with your specific EDI format.

Efficacy of the CCI File

For ideas in improving the CCI data, please see CCI - Data Efficacy.