Table of Contents |
---|
...
Information Requirements
Order Detail Information
Field Name | Type | Length | Mandatory | minOccurence | Description |
---|
OrderReferenceNumber | Text/Numeric | 30 | Mandatory | 1 | Must be Unique |
Additional Reference | References | 30 | Optional | 0* |
ThirdPartyAccount | Text | 20 | Optional | 0* | Provide the Carrier Account if the receiver or a Third Party will be paying for this freight. |
CostCentre | Text | 30 | Optional | 0* | Cost Centre implementations vary. Please speak with Account Manager regarding use. |
Service | Text | 20 | Optional | 0-1 | Preferred service following the Service Code provided by EFM. Must comply with the code otherwise will be ignored. |
Sender | Optional | 0-1 | Only used when creating return or third party orders when a sender needs to be specified. |
Receiver | Mandatory | 1 |
Items | Recommended | 0-1* |
Atl - Authority to Leave | Boolean | 5 |
Mandatory
true/false/blank
Delivery Instructions
Text
60
Recommended
1
Special Instructions
Text
60
Recommended
1
Optional | 0-1 | Only accepts the value: true/false | |||
UserField1 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index |
UserField2 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index |
UserField3 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index |
UserField4 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index |
UserField5 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index |
Anchor | ||||
---|---|---|---|---|
|
...
Address Type Information
Field Name | Type | Length | Mandatory | minOccurence | Description |
---|
Name | Text | 30 | Mandatory | 1 |
Address1 | Text | 30 | Mandatory | 1 |
Address2 | Text | 30 | Optional | 1 |
Locality | Text | 30 | Mandatory | 1 |
State | Text | 5 | Mandatory | 1 |
Postcode | Text | 5 | Mandatory | 1 |
ContactName | Text | 20 | Optional | 0-1 |
ContactPhone | Text | 15 | Optional | 0-1 |
ContactEmail | Text | 50 | Recommended | 0-1 | |
Instructions | Text | 80 | Optional | 0-1 |
Anchor | ||||
---|---|---|---|---|
|
Field Name | Type | Length | Mandatory | minOccurence | Description | |
---|---|---|---|---|---|---|
1 | Reference | Text | 20 | Recommended | 1 | |
2 | Code | Text | 20 | Recommended | 1 | |
3 | PackagingType | Test | 20 | Recommended | 1 | |
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 with comments
...
Code Block | ||
---|---|---|
| ||
<?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://flipgroupflip-eng.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type2451651171 --> <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://flipgroupflip-eng.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type2451651171 --> <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> |
...