Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
The customers system generates a file with the consignment information. 
The file must:
  • CSV/XML Format
  • Contain the order file Information documented
  • Limit to one Order/Consignment per file
    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.
  • Performing Order Lookup

    Image Removed

    System Component Map

    Image Removed


    Warning
    titleWARNING

    Custom Services are only available upon evaluation and require internal 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

    Anchor
    AddressType
    AddressType
    Address Type Information

    Field No.

    Field Name

    Type

    Length

    Mandatory

    Multiplicity

    Description

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

    Anchor
    ItemType
    ItemType
    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

    Code Block
    languagexml
    themeRDark
    titleOrderXML
    <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>