null

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

WARNING

Custom Services are only available upon evaluation and require EFM Solutions approval before moving forward.

Information Requirements

Order Detail Information

Field No.

Field Name

Type

Length

Mandatory

Multiplicity

Description

1OrderReferenceNumberText/Numeric30Mandatory1Must be Unique
2Additional ReferenceReferences30Optional0*
3ServiceText20Optional0-1Preferred service following the Service Code provided by EFM. Must comply with the code otherwise will be ignored.
4SenderAddress
Optional0-1Only used when creating return or third party orders when a sender needs to be specified.
5

Receiver

Address


Mandatory

1


6ItemsItem
Recommended0-1*
7Authority to LeaveBoolean5Mandatory
true/false/blank
8

Delivery Instructions

Text

60

Recommended

1


9

Special Instructions

Text

60

Recommended

1


10UserField1Text30Optional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
11UserField2Text30Optional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
12UserField3Text30Optional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
13UserField4Text30Optional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index
14UserField5Text30Optional
Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index

Receiver Address Type Information

Field No.

Field Name

Type

Length

Mandatory

Multiplicity

Description

1NameText30Mandatory1
2Address1Text30Mandatory1
3Address2Text30Optional1
4LocalityText30Mandatory1
5StateText5Mandatory1
6PostcodeText5Mandatory1
7ContactNameText20Optional0-1
8ContactPhoneText15Optional0-1
9ContactEmailText50Recommended0-1

Item Type Information

Field No.

Field Name

Type

Length

Mandatory

Multiplicity

Description

1ReferenceText30Recommended1
2CodeText30Recommended1Defined: https://portal.oneflo.com.au/MyProducts/Index
3DescriptionText30Recommended1Description of the package
4ItemsNumeric
Recommended1number of items of this type / dims / weight
5LengthNumeric
Recommended1in centimetres, must be whole number
6WidthNumeric
Recommended1in centimetres, must be whole number
7HeightNumeric
Recommended1in centimetres, must be whole number
8WeightNumeric
Recommended1in kilograms, can include decimal
9VolumeNumeric
Optional1in cubic metres, can include decimal

Example Files

XML

XML with comments:

Order Lookup With Comments
<?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>CARTON</Reference>							
					<Code>CT</Code>										
					<Description>CARTON of toy cars</Description>							
					<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>SATCHEL</Reference>							<!-- Defined: https://portal.oneflo.com.au/MyProducts/Index -->
					<Code>SAT</Code>										
					<Description>CARTON of toy cars</Description>							
					<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>2</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
<?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</Code>										
					<Description>CARTON of toy cars</Description>							
					<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>SAT</Code>										
					<Description>CARTON of toy cars</Description>							
					<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

  • No labels