Introduction
This page includes a list and definition of Complex Types used in the SOAP API environment of OneFlo. These complex types are used as INPUT to the Web Service calls to OneFlo in order to elicit a response. The RESPONSE may also be a complex type, especially when the expected response is an object with multiple attributes.
Consignment
| Type | INPUT / RESPONSE |
|---|---|
| Useful for | Creating and releasing consignments |
| Used in | SaveConsignment |
The Consignment object represents the data of the freight that is created in OneFlo. It contains information regarding the freight's account owner, distributor, sender, receiver, instructions, and line item details including whether the freight contains DG or not and other relevant information.
XSD
Consignment
<xs:complexType name="Consignment"> <xs:sequence> <xs:element minOccurs="0" name="AccountID" type="xs:int"/> <xs:element minOccurs="0" name="CloseAt" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ConsignmentDate" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ConsignmentID" type="xs:long"/> <xs:element minOccurs="0" name="ConsignmentItems" nillable="true" type="tns:ArrayOfConsignmentItem"/> <xs:element minOccurs="0" name="ConsignmentNote" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ConsignmentType" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ConsolidatedSus" nillable="true" type="tns:ArrayOfConsolidateConsignment"/> <xs:element minOccurs="0" name="ContainingConsignment" type="xs:long"/> <xs:element minOccurs="0" name="DeliveryInstructions" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="DistributorID" type="xs:int"/> <xs:element minOccurs="0" name="DownloadID" type="xs:int"/> <xs:element minOccurs="0" name="Exception" nillable="true" type="tns:SaveException"/> <xs:element minOccurs="0" name="Ext" nillable="true" type="tns:ConsignmentExt"/> <xs:element minOccurs="0" name="ExtraInfo" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Hours" type="xs:float"/> <xs:element minOccurs="0" name="ModifiedBy" type="xs:int"/> <xs:element minOccurs="0" name="NoItems" type="xs:short"/> <xs:element minOccurs="0" name="OnForwarder" type="xs:int"/> <xs:element minOccurs="0" name="PickupInstructions" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ReadyAt" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Receiver" nillable="true" type="tns:Address"/> <xs:element minOccurs="0" name="Reference" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="References" nillable="true" type="tns:ArrayOfReference"/> <xs:element minOccurs="0" name="Released" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Sender" nillable="true" type="tns:Address"/> <xs:element minOccurs="0" name="Service" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="SessionID" type="xs:long"/> <xs:element minOccurs="0" name="SpecialInstructions" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Volume" type="xs:float"/> <xs:element minOccurs="0" name="Weight" type="xs:float"/> </xs:sequence> </xs:complexType> <xs:element name="Consignment" nillable="true" type="tns:Consignment"/>
Elements
| Element | Type | Mandatory / Optional | Length | Comments |
|---|---|---|---|---|
| AccountID | int | M | - | AccountID retrieved from Session. |
| DistributorID | int | M | - | DistributorID retrieved from Session. |
| OnForwarder | int | O | - | Not required when Service is provided. |
| ConsignmentID | long | O | - | ID of the record in the OneFlo database. Not required on creation. When updating an existing consignment, provide the ConsignmentID. |
| ConsignmentDate | DateTime | M | - | Date of the creation of the consignment. |
| Released | DateTime | M | - | Date of the release of the consignment, must be provided but will be updated by the system when the consignment is actually released via the Release*Consignment API. |
| ConsignmentNote | string | O | 20 | |
| Service | string | M | 10 | Service for use. Must be a service defined in OneFlo as retrieved from the ShipperService Element of the ServicePricing. |
| Sender | Address | M | 1 | Details of the sender of the freight. |
| PickupInstructions | string | O | 80 | Pickup Instructions. Will appear on Pickup request data when carrier is configured. |
| Receiver | Address | M | 1 | Details of the receiver of the freight. |
| DeliveryInstructions | string | O | 80 | Delivery Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate). |
| SpecialInstructions | string | O | 80 | Additional Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate). |
| Description | string | O | 30 | Description of Consignment. Won't appear on labels. |
| Ext | ConsignmentsExt | O | 0...1 | Additional information for a consignment. |
| Hours | float | O | - | Default 0. |
| NoItems | short | M | - | Item Count Summary for the consignment. |
| Volume | float | M | - | Total Consignment Volume in cubic metres. |
| Weight | float | M | - | Total Consignment weight in kilograms. |
| ConsignmentItems | ConsignmentItem[] | M | 1...n | Details the items included in the consignment. |
| ReadyAt | Time | M | - | hh:mm Time when the consignment is ready to be picked up. Will be reflected on Pickup Request and cosignment data sent to carrier. |
| CloseAt | Time | M | - | hh:mm Time when the facilities will close (for pickup). Will be reflected on the Pickup Request and consignment data sent to carrier. |
| Reference | string | O | 20 | Stores the primary business reference (i.e. Sales Order Number, Pick Number, etc) |
| References | Reference[] | O | 0...n | Additional References. |
| ModifiedBy | int | M | - | UserID as defined in the session. |
| SessionID | long | O | - | Not recommended for use. |
| ExtraInfo | string | O | - | Not recommended for use. |
| ConsolidatedSus | ConsolidateConsignment[] | O | - | Not recommended for use. |
| ContainingConsignment | long | O | - | Not recommended for use. |
| DownloadID | int | O | - | Not recommended for use. |
| ConsignmentType | string | O | - | Not recommended for use. |
| Exception | SaveException | O | - | Output. Provides detail on the result if there is an error with the data provided. |
Example
Address
| Type | INPUT / RESPONSE |
|---|---|
| Useful for | Creating and releasing consignments |
| Used in | SaveConsignment |
The address field defines the structure of the address entity in the OneFlo database. This address entity is used as components of the Consignment element via its Sender and Receiver elements.
XSD
<xs:complexType name="Address"> <xs:sequence>https://www.youtube.com/watch?v=bbStdHPMMf4 <xs:element minOccurs="0" name="AccountID" type="xs:int"/> <xs:element minOccurs="0" name="AddressID" type="xs:int"/> <xs:element minOccurs="0" name="AddressLocation" nillable="true" type="tns:Location"/> <xs:element minOccurs="0" name="ContactName" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Email" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Exception" nillable="true" type="tns:SaveException"/> <xs:element minOccurs="0" name="Fax" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Line1" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Line2" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Line3" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="LocationDetails" nillable="true" type="tns:Location"/> <xs:element minOccurs="0" name="LocationID" type="xs:int"/> <xs:element minOccurs="0" name="ModifiedBy" type="xs:int"/> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="State" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="Suburb" nillable="true" type="xs:string"/> </xs:sequence> </xs:complexType> <xs:element name="Address" nillable="true" type="tns:Address"/>
Elements
| Element | Type | Mandatory / Optional | Length | Comments |
|---|---|---|---|---|
| AccountID | int | M | - | Owner of this address entity in the OneFlo database. |
| AddressID | int | O | - | The record ID of this address entity. |
| Name | string | M | 50 | Entity or Company name. Could be the name of the person receiving the freight. |
| Line1 | string | M | 30 | First line of the address. Must be provided so it appears on the label + postback. |
| Line2 | string | O | 30 | Additional line, when required. Will appear on label + postback. |
| Line3 | string | O | 30 | Extra line. Most carrier labels don't render this. |
| LocationID | int | M | - | LocationID in the OneFlo database. LocationID can be retrieved from the ValidateLocation API. BEST PRACTICE: If known and provided, no need to define the AddressLocation and LocationDetails of this Address and providing this is more accurate than using AddressLocation or LocationDetails |
| ContactName | string | M | 20 | Name of person / contact for this address entity. Will appear on label. |
| Phone | string | O | 15 | Phone number of contact. Will appear on Label. |
| string | O | 50 | Email address of contact. When populated in Consignment.Receiver, this will be used to deliver ASNs. | |
| Fax | string | O | 15 | |
| AddressLocation | Location | O | 0...1 | No need to define this element if the LocationID or LocationDetails element is provided. |
| LocationDetails | Location | O | 0...1 | No need to define this element if the LocationID or AddressLocation element is provided. |
| ModifiedBy | int | M | - | UserID as defined in the session. |
| State | string | O | 5 | Not recommended for use. |
| Suburb | string | O | 50 | Not recommended for use. |
| Exception | SaveException | O | - | Output. Provides detail on the result if there is an error with the data provided. |
ServicePricing
| Type | RESPONSE Only |
|---|---|
| Useful for | Consignment Creation / Modification |
| Used in | GetChargeQuote |
Service pricing is the result of a quote request. This defines the available services given a quoted freight profile. Please refer to the GetChargeQuote* API calls
XSD
<xs:complexType name="ServicePricing"> <xs:sequence> <xs:element minOccurs="0" name="CalculatedSUType" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="CarrierID" type="xs:int"/> <xs:element minOccurs="0" name="CarrierName" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="CarrierService" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ETA" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="FeesCharge" type="xs:decimal"/> <xs:element minOccurs="0" name="FreightCharge" type="xs:decimal"/> <xs:element minOccurs="0" name="ID" type="xs:int"/> <xs:element minOccurs="0" name="NetCharge" type="xs:decimal"/> <xs:element minOccurs="0" name="RateID" type="xs:int"/> <xs:element minOccurs="0" name="ServiceName" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ShipperService" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="TaxCharge" type="xs:decimal"/> <xs:element minOccurs="0" name="TotalCharge" type="xs:decimal"/> <xs:element minOccurs="0" name="WebDescription" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ZoneFrom" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="ZoneTo" nillable="true" type="xs:string"/> </xs:sequence> </xs:complexType> <xs:element name="ServicePricing" nillable="true" type="tns:ServicePricing"/>
Elements
| Element | Type | Mandatory / Optional | Length | Comments |
|---|---|---|---|---|
| CalculatedSUType | string | - | - | If the rate in the system is calculated against a Shipping Unit type, this is represented as a CalculatedSUType. |
| CarrierID | int | - | - | ID of the carrier in OneFlo. |
| CarrierName | string | - | - | Full name of the carrier in OneFlo. |
| CarrierService | string | - | - | Carrier side service |
| ETA | string | - | - | Estimated Delivery Date as provided by the carrier for the lane. OneFlo must have this information before it's provided. |
| FeesCharge | decimal | - | - | Freight Fees |
| FreightCharge | decimal | - | - | Freight charge |
| ID | int | - | - | Not used. |
| NetCharge | decimal | - | - | Net freight charge |
| RateID | int | - | - | OneFlo Rate ID |
| ServiceName | stirng | - | - | OneFlo full service name. |
| ShipperService | string | - | - | OneFlo carrier service code. This is the code to be provided as a Service when creating/modifying the Consignment object. |
| TaxCharge | decimal | - | - | GST |
| TotalCharge | decimal | - | - | NetCharge + GST |
| WebDescription | string | - | - | OneFlo Service Description |
| ZoneFrom | string | - | - | OneFlo carrier Zone source |
| ZoneTo | string | - | - | OneFlo carrier Zone destination |
Example
<ServicePricing>
<CalculatedSUType>FP</CalculatedSUType>
<CarrierID>102958</CarrierID>
<CarrierName>Hi-Trans Express Pty Ltd</CarrierName>
<CarrierService>G</CarrierService>
<ETA/>
<FeesCharge>25.5400</FeesCharge>
<FreightCharge>150.1600</FreightCharge>
<ID>0</ID>
<NetCharge>175.7000</NetCharge>
<RateID>10702459</RateID>
<ServiceName>Hi Trans General Service</ServiceName>
<ShipperService>HITRANG</ShipperService>
<TaxCharge>17.5700</TaxCharge>
<TotalCharge>193.2700</TotalCharge>
<WebDescription>Hi-Trans General</WebDescription>
<ZoneFrom>MEL</ZoneFrom>
<ZoneTo>NS6S</ZoneTo>
</ServicePricing>