Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

Table of Contents

...

Warning

...

titleWARNING

Customisations

Any variations from this standard template will only be available upon evaluation, and

...

requires Flip approval before moving forward.

Information Requirements

Order Detail Information

Field

...

Name

Type

Length

Mandatory

...

minOccurence

Description

1

OrderReferenceNumber

Text/Numeric

30

Mandatory

1

Must be Unique

2

Additional Reference

References

30

Optional

0*


3

...

ThirdPartyAccount

Text

20

Optional

0

...

*

Provide the Carrier Account if the receiver or a Third Party will be paying for this freight.

4

CostCentre

Text

30

Optional

0*

Cost Centre implementations vary. Please speak with Account Manager regarding use.

5

Service

Text

20

Optional

0-1

Preferred service following the Service Code provided by EFM. Must comply with the code otherwise will be ignored.

...

6

Sender

Address


Optional

0-1

Only used when creating return or third party orders when a sender needs to be specified.

...

7

Receiver

Address


Mandatory

1

...


8

Items

Item


Recommended

0-1*

...


9

Atl - Authority to Leave

Boolean

5

Optional

...

0-1

Only accepts the value: true/false

...

...

10

Delivery Instructions

Text

60

Recommended

1

...


11

Special Instructions

Text

60

Recommended

1

...


12

UserField1

Text

30

Optional


Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

...

13

UserField2

Text

30

Optional


Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

...

14

UserField3

Text

30

Optional


Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

...

15

UserField4

Text

30

Optional


Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

...

16

UserField5

Text

30

Optional


Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

Anchor
AddressType
AddressType
Receiver Address Type Information

...

Field Name

Type

Length

Mandatory

...

minOccurence

Description

1

Name

Text

30

Mandatory

1


2

Address1

Text

30

Mandatory

1


3

Address2

Text

30

Optional

1


4

Locality

Text

30

Mandatory

1


5

State

Text

5

Mandatory

1


6

Postcode

Text

5

Mandatory

1


7

ContactName

Text

20

Optional

0-1


8

ContactPhone

Text

15

Optional

0-1


9

ContactEmail

Text

50

Recommended

0-1


Anchor
ItemType
ItemType
Item Type Information

...

Field Name

Type

Length

Mandatory

...

minOccurence

Description

1

Reference

Text

20

Recommended

1


2

Code

Text

20

Recommended

1

Defined: https://portal.oneflo.com.au/MyProducts/Index

3

PackagingType

Test

20

Recommended

1

Shipping Items - Packaging Type

4

Description

Text

40

Recommended

1

Description of the package

...

5

Items

Numeric


Recommended

1

number of items of this type / dims / weight

...

6

Length

Numeric


Recommended

1

in centimetres, must be whole number

...

7

Width

Numeric


Recommended

1

in centimetres, must be whole number

...

8

Height

Numeric


Recommended

1

in centimetres, must be whole number

...

9

Weight

Numeric


Recommended

1

in kilograms, can include decimal

...

10

Volume

Numeric


Optional

1

in cubic metres, can include decimal

...


Sample Files

XML

...

XML with comments:

...

with comments

Order Lookup With Comments

...

Code Block

...

language

...

xml
<?xml version="1.0" encoding="utf-8"?>
<CreateOrderLookup>
	<Orders>
		<Order>
			<AccountId>000000</AccountId>
			<OrderReference>BANANA4</OrderReference>						<!-- Mandatory: The primary reference number for your consignment. Also used to look up this order -->
			<References>													<!-- Optional -->
				<string></string>											<!-- Repeat for as many references you wish to add-->
			</References>						
            <DispatchDate>2018-10-23</DispatchDate>							<!-- Optional -->	
            <CostCentre>APPLE1</CostCentre>									<!-- Optional -->
            <ThirdPartyAccount>APPLE36</ThirdPartyAccount>					<!-- Optional -->
			<Service>TEST</Service>											<!-- Optional: If an incorrect service code is used it will successfully import without selecting a service -->
			<Receiver>
				<Name>Sample Receiver</Name>								<!-- Mandatory -->
				<Line1>123 Sample Road</Line1>								<!-- Mandatory -->
				<Line2>Receiving Dock 2</Line2>
				<Suburb>MELBOURNE</Suburb>									<!-- Mandatory -->
				<State>VIC</State>											<!-- Mandatory -->
				<Postcode>3000</Postcode>									<!-- Mandatory -->
				<Country>AU</Country>										<!-- Mandatory -->
				<ContactName>Sample Contact</ContactName>
				<Email>contact@sampledomain.com.au</Email> 					<!-- Mandatory when ASN is activated-->
				<Phone>0411 999 999</Phone>
				<Atl>true</Atl>												<!-- Optional: Flags Authority to Leave. Possible values: true / false / blank -->
				<Instructions>Signature Required</Instructions>				<!-- Optional, limit 60char -->    
			</Receiver>
			<UserFields>													<!-- Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index -->
																			<!-- If Not Used, Remove whole element-->
				<UserField1>506180</UserField1>
				<UserField2>Inspected and Confirmed</UserField2>
				<UserField3>MISC</UserField3>
				<UserField4>Rest</UserField4>
				<UserField5>OR-9874152162196</UserField5>
			</UserFields>
			<ShippingUnits>													<!--Optional: If you are can provide your shipping unit details.-->
																			<!-- If Not Used, Remove whole element-->
				<ShippingUnit>												<!-- Define One or many items as per

...

 the below structure -->
					<Reference>Order001</Reference>							
					<Code>SAT</Code>										<!-- Defined: https://portal.oneflo.com.au/MyProducts/Index -->
					

...

<Description>Carton of goodies</Description>							
					

...

<PackagingType>CTN</

...

PackagingType>						

...

<!-- Defined: https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type -->
					

...

<Items>1</Items>										<!-- number of items of this type / dims / weight -->
					<Length>10</Length>										<!-- in centimetres,  must be whole number-->
					<Height>10</Height>										<!-- in centimetres, must be whole number -->
					<Width>10</Width>										<!-- in centimetres, must be whole number -->
					<Weight>2</Weight>										<!-- in kilograms, can include decimal -->
					<Volume>0.001</Volume>									<!-- in cubic metres, can include decimal -->

...

				</ShippingUnit>
				<ShippingUnit>
					<Reference>Order002</Reference>			

...

				

...


					

...

<Code>1KGSAT</Code>										<!-- Defined: https://portal.oneflo.com.au/MyProducts/Index -->
					

...

<Description>Satchel 1KG</

...

Description>			
					<PackagingType>SAT</PackagingType>		

...

				

...

<!-- Defined: https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type -->
					<Items>1</Items>										<!-- number of items of this type / dims / weight -->
					<Length>10</Length>										<!-- in centimetres, must be whole number-->
					<Height>10</Height>										<!-- in centimetres, must be whole number -->
					<Width>2</Width>										<!-- in centimetres, must be whole number -->
					

...

<Weight>1</Weight>										<!-- in kilograms, can include decimal -->
					<Volume>0.001</Volume>									<!-- in cubic metres, can include decimal -->
				</ShippingUnit>
			</ShippingUnits>
		</Order>
	</Orders>
</CreateOrderLookup>

XML

...

...

Order Lookup Template

...

Code Block

...

language

...

xml
<?xml version="1.0" encoding="utf-8"?>
<CreateOrderLookup>
	<Orders>
		<Order>
			<AccountId>000000</AccountId>
			<OrderReference>BANANA4</OrderReference>						
			<References>													
				<string></string>											
			</References>						
            <DispatchDate>2018-10-23</DispatchDate>								
            <CostCentre>APPLE1</CostCentre>									
            <ThirdPartyAccount>APPLE36</ThirdPartyAccount>					
			<Service>TEST</Service>											
			<Receiver>
				<Name>Sample Receiver</Name>
				<Line1>123 Sample Road</Line1>
				<Line2>Receiving Dock 2</Line2>
				<Suburb>MELBOURNE</Suburb>
				<State>VIC</State>
				<Postcode>3000</Postcode>
				<Country>AU</Country>
				<ContactName>Sample Contact</ContactName>
				<Email>contact@sampledomain.com.au</Email>
				<Phone>0411 999 999</Phone>
				<Atl>true</Atl>
				<Instructions>Signature Required</Instructions>
			</Receiver>
			<UserFields>
				<UserField1>506180</UserField1>
				<UserField2>Inspected and Confirmed</UserField2>
				<UserField3>MISC</UserField3>
				<UserField4>Rest</UserField4>
				<UserField5>OR-9874152162196</UserField5>
			</UserFields>
			<ShippingUnits>
				<ShippingUnit>
					<Reference>CARTON</Reference>							
					

...

<Code>CT-SMALL</Code>										
					<Description>CARTON of toy cars<

...

/Description>							
					<PackagingType>CTN</PackagingType>
					<Items>1</Items>
					<Length>10</Length>
					<Height>10</Height>
					<Width>10</Width>
					<Weight>2</Weight>
					<Volume>0.001</Volume>
				</ShippingUnit>
				<ShippingUnit>
					<Reference>SATCHEL</Reference>
					

...

<Code>1KGSAT</Code>										
					

...

<Description>SATCHEL of 

...

Replacement 

...

screws</Description>
					

...

<PackagingType>SAT</PackagingType>
					<Items>1</Items>
					<Length>10</Length>
					<Height>10</Height>
					<Width>2</Width>
					<Weight>2</Weight>
					<Volume>0.001</Volume>
				</ShippingUnit>
			</ShippingUnits>
		</Order>
	</Orders>
</CreateOrderLookup>

CSV

CSV No Items

...

Order_Lookup_Consignment.csv

Consignment CSV Import
Code Block
languagexml

...

OrderReferenceNumber,References,Service,Name,Address1,Address2,Locality,State,Postcode,ContactName,ContactPhone,ContactEmail,Authority to Leave,Delivery Instructions,Special Instructions,UserField1,UserField2,UserField3,UserField4,UserField5

CSV with Items

...

 

Order_Lookup_Consignment

...

.csv

Consignment CSV Import
Code Block
languagexml

...

...

OrderReferenceNumber,References,Service,Name,Address1,Address2,Locality,State,Postcode,ContactName,ContactPhone,ContactEmail,Authority to Leave,Delivery Instructions,Special Instructions,UserField1,UserField2,UserField3,UserField4,UserField5,ItemReference,Code,Description,Items,Length,Width,Height,Weight

...