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 31 Next »

How does Order Lookup work?

Complete Message Transmitter Service

  1. The Customer system generates a File with consignment Information on the Customer's Server. The File must be.
    1. CSV/XML Format
    2. Contain the order file Information listed below
    3. Limited to one file per Order
  2. 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.
  3. Customer uses OneFlo Portal to "Look up" the consignment that can now be found within the system.


Custom Message Transmitter Service

  1. The customer system sends an XML Payload of all required data, to a custom API End Point.
    1. This Payload must meet OneFlo information requirements perfectly.
  2. 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 (Installing Order Lookup) 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

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

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

OrderXML
<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>
  • No labels