How does Order Lookup work?
Complete Message Transmitter Service
- The Customer system generates a File with consignment Information on the Customer's Server. The File must be.
- CSV/XML Format
- Contain the order file Information listed below
- Limited to one file per Order
- EFM Installs a Windows Service on the Customer's Server to pick up this File and send it to our Message Transmitter Service which transforms this File into a standard Message that OneFlo can interpret.
- Customer uses OneFlo Portal to "Look up" the consignment that can now be found within the system.
Custom Message Transmitter Service
- The customer system sends an XML Payload of all required data, to a custom API End Point.
- This Payload must meet OneFlo information requirements perfectly.
- Customer uses OneFlo UI to "Look up" the consignment that can now be found within the system.
Performing Order Lookup
System Component Map
WARNING
Custom Services are only available upon evaluation and require internal approval before moving forward.
Components
Customer System
Customer's system used as the source system for order data. Provider order data is exportable into an EDI file that will act as a data feed to the Message Transmitter process
Customer Workstation
Customer uses their consigning workstations to access the OneFlo portal to be able to access OneFlo functionality.
OneFlo Portal
OneFlo is a cloud based, multi-carrier, Logistics Management System designed for consigning, manifesting & tracking consignments, tracking carrier performance & enabling logistics-based reports for analyzing supply chain activity. Order Lookup is accessed via the OneFlo Portal.
OneFlo Order Integration Service
The Order Integration service (Order Lookup - Installation) is designed to increase the efficiency of the despatch process by identifying and loading order data based on EDI files. The service identifies order EDI files and loads the contents as an order into OneFlo. Once loaded the order is accessible in the OneFlo portal and upon selecting the order all order data is mapped to the consignment creation form. The population of this data reduces data entry required by the despatch teams and increases accuracy of the consignment data.
OneFlo Postback Report
In order to populate consignment number against the original Order in efm a OneFlo Postback data file can be generated on a nightly schedule. This data file will be transferred over to Customer where a efm service will load the file data to update Orders. This function requires Customer to nominate an FTP server that OneFlo can use to place the nightly batch file.
Information Requirements
Customer order data required may vary depending on the process the Order Lookup integration is intended to achieve.
The following specification defines an XML structure for the Order Detail. When the source system can only produce a CSV, please consult the efm Technical Solutions Contact assigned.
Order Detail Information
Field No. | Field Name | Type | Length | Mandatory | Multiplicity | Description |
---|---|---|---|---|---|---|
1 | OrderReferenceNumber | Text/Numeric | 30 | Mandatory | 1 | Must be Unique |
2 | Additional Reference | References | 30 | Optional | 0* | |
3 | Service | Text | 20 | Optional | 0-1 | Preferred service following the Service Code provided by EFM. Must comply with the code otherwise will be ignored. |
4 | Sender | Address | Optional | 0-1 | Only used when creating return or third party orders when a sender needs to be specified. | |
5 | Receiver | Mandatory | 1 | |||
6 | Items | Item | Recommended | 0-1* | ||
7 | Authority to Leave | Boolean | 5 | Mandatory | true/false/blank | |
8 | Delivery Instructions | Text | 60 | Recommended | 1 | |
9 | Special Instructions | Text | 60 | Recommended | 1 | |
10 | UserField1 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index | |
11 | UserField2 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index | |
12 | UserField3 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index | |
13 | UserField4 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index | |
14 | UserField5 | Text | 30 | Optional | Custom fields configured in OneFlo. Defined in https://portal.oneflo.com.au/MyUserFields/Index |
Address Type Information
Field No. | Field Name | Type | Length | Mandatory | Multiplicity | 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 |
Item Type Information
Field No. | Field Name | Type | Length | Mandatory | Multiplicity | Description |
---|---|---|---|---|---|---|
1 | Reference | Text | 30 | Recommended | 1 | |
2 | Code | Text | 30 | Recommended | 1 | Defined: https://portal.oneflo.com.au/MyProducts/Index |
3 | Description | Text | 30 | Recommended | 1 | Description of the package |
4 | Items | Numeric | Recommended | 1 | number of items of this type / dims / weight | |
5 | Length | Numeric | Recommended | 1 | in centimetres, must be whole number | |
6 | Width | Numeric | Recommended | 1 | in centimetres, must be whole number | |
7 | Height | Numeric | Recommended | 1 | in centimetres, must be whole number | |
8 | Weight | Numeric | Recommended | 1 | in kilograms, can include decimal | |
9 | Volume | Numeric | Optional | 1 | in cubic metres, can include decimal |
Example Files
XML
<OrderData xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <OrderDetail> <OrderReference>3081973</OrderReference> <Service>IPECX</Service> <References> <Reference>ExtraReference</Reference> </References> <Receiver> <Name>Receiver Name</Name> <Address1>89 Koala St</Address1> <Locality>Footscray</Locality> <State>VIC</State> <Postcode>3011</Postcode> <ContactName>Receiver Contact</ContactName> <ContactPhone>+6134567890</ContactPhone> </Receiver> <Items> <Code>CA25SP</Code> <Length>0.280</Length> <Width>0.280</Width> <Height>0.090</Height> <Weight>1.544</Weight> <Description>Box of Nails</Description> </Items> </OrderDetail> </OrderData>