| Table of Contents |
|---|
...
| Element | Type | Mandatory / Optional | Length | Direction | Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AccountID | int |
| - |
| AccountID retrieved from Session. | ||||||||||||||
| AllowConsolidation | bool |
| - |
| true/false : Indicates whether a consignment can be consolidated. If it's the first consignment for the day going to a receiver and service, a new consignment will be created. Succeeding consignments going to the same receiver and same service, the new items in this consignment will be appended to the previous consignment (that allows consolidation) and using the same connote number. This doesn't apply to consignments with Dangerous Goods. | ||||||||||||||
| CloseAt | Time |
| - |
| hh:mm Time when the facilities will close (for pickup). Will be reflected on the Pickup Request and consignment data sent to carrier. | ||||||||||||||
| ConsignmentDate | DateTime |
| - |
| Date of the creation of the consignment. | ||||||||||||||
| ConsignmentID | long |
| - |
| ID of the record in the OneFlo database. Not required on creation. When updating an existing consignment, provide the ConsignmentID. | ||||||||||||||
| ConsignmentItems | ConsignmentItem[] |
| 1...n |
| Details the items included in the consignment. | ||||||||||||||
| ConsignmentNote | string |
| 20 |
| When provided, the consignment will be created with the provided Connote number. When not provided, OneFlo will generate a new connote number from the range. | ||||||||||||||
| ConsignmentType | string |
| - |
| Not recommended for use. | ||||||||||||||
| ConsolidatedSus | ConsolidateConsignment[] |
| - |
| Not recommended for use. | ||||||||||||||
| ContainingConsignment | long |
| - |
| Not recommended for use. | ||||||||||||||
| DeliveryInstructions | string |
| 80 |
| Delivery Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate). | ||||||||||||||
| Description | string |
| 30 |
| Description of Consignment. Won't appear on labels. | ||||||||||||||
| DistributorID | int |
| - |
| DistributorID retrieved from Session. | ||||||||||||||
| DownloadID | int |
| - |
| Not recommended for use. | ||||||||||||||
| Exception | SaveException |
| - |
| Output. Provides detail on the result if there is an error with the data provided. | ||||||||||||||
| Ext | ConsignmentsExt |
| 0...1 |
| Additional information for a consignment. | ||||||||||||||
| ExtraInfo | string |
| - |
| Not recommended for use. | ||||||||||||||
| Hours | float |
| - |
| Default 0. | ||||||||||||||
| ModifiedBy | int |
| - |
| UserID as defined in the session. | ||||||||||||||
| NoItems | short |
| - |
| Item Count Summary for the consignment. Computed from the data provided in ConsignmentItems. | ||||||||||||||
| OnForwarder | int |
| - |
| Not required when Service is provided. | ||||||||||||||
| PickupInstructions | string |
| 80 |
| Pickup Instructions. Will appear on Pickup request data when carrier is configured. | ||||||||||||||
| ReadyAt | Time |
| - |
| hh:mm Time when the consignment is ready to be picked up. Will be reflected on Pickup Request and cosignment data sent to carrier. | ||||||||||||||
| Receiver | Address |
| 1 |
| Details of the receiver of the freight. | ||||||||||||||
| Reference | string |
| 20 |
| Stores the primary business reference (i.e. Sales Order Number, Pick Number, etc) | ||||||||||||||
| References | Reference[] |
| 0...n |
| Additional References. | ||||||||||||||
| Released | DateTime |
| - |
| 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. | ||||||||||||||
| Sender | Address |
| 1 |
| Details of the sender of the freight. | ||||||||||||||
| Service | string |
| 10 |
| Service for use. Must be a service defined in OneFlo as retrieved from the ShipperService Element of the ServicePricing. | ||||||||||||||
| SessionID | long |
| - |
| Not recommended for use. | ||||||||||||||
| SpecialInstructions | string |
| 80 |
| Additional Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate). | ||||||||||||||
| Volume | float |
| - |
| Total Consignment Volume in cubic metres. Computed from the data provided in ConsignmentItems. | ||||||||||||||
| Weight | float |
| - |
| Total Consignment weight in kilograms. Computed from the data provided in ConsignmentItems. |
...
| Element | Type | Mandatory / Optional | Length | Direction | Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Barcode | string |
| - |
| This is the SSCC barcode. If no SSCC is provided, OneFlo will generate a barcode for you. | ||||||||||||||
| ConsignmentID | long |
| - |
| ID of the record in the OneFlo database. Not required on creation. When updating an existing consignment, provide the ConsignmentID. | ||||||||||||||
| ConsignmentProduct | Product |
| - |
| This is a complex type for the definition of Dangerous Goods. | ||||||||||||||
| Description | string |
| 40 |
| A description of the goods being shipped. | ||||||||||||||
| ExchangeReturnable | boolean |
| - |
| |||||||||||||||
| Height | float |
| - |
| Height of item in centimetres (cm). | ||||||||||||||
| ItemNo | int |
| - |
| The index (starting 1) or otherwise known as ordinal integer. e.g. if there are 3 packages, this will enumerate package 1, package 2, and package 3 | ||||||||||||||
| ItemType | string |
| 20 |
| Item Code - could be your warehouse Shipping Unit code (i.e. Carton_12X or CHEP_Pallet) | ||||||||||||||
| Length | float |
| - |
| Length of item in centimetres (cm). | ||||||||||||||
| ModifiedBy | int |
| - |
| |||||||||||||||
| NoItems | int |
| 1... |
| Total Number of SUs for the consignment. Must be a positive integer. Ideally when enumerating items, this must have a value of '1'. | ||||||||||||||
| PackagingType | string |
| 20 |
| Should be one of the available packaging types in OneFlo. Shipping Items - Packaging Type. | ||||||||||||||
| Palletised | boolean |
| - |
| Non-mandatory, please see Packaging Type. | ||||||||||||||
| ProductID | int |
| - |
| |||||||||||||||
| Reference | string |
| 20 |
| Item Reference associated to the order. This is useful for consolidated items where items need to be identified into which particular order it's under. This can also be used to indicate specifically which references are associated to the shipping unit. | ||||||||||||||
| Returnable | string |
| 20 |
| |||||||||||||||
| Volume | float |
| - |
| Cubic metres (m3). Up to 3 decimal places. | ||||||||||||||
| Weight | float |
| - |
| Weight of the item in kilograms (kg). | ||||||||||||||
| Width | float |
| - |
| Width of item in centimetres (cm). |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<xs:complexType name="Address"> <xs:sequence>https://www.youtube.com/watch?v=bbStdHPMMf4sequence> <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="ATL" type="xs:boolean"/> <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"/> |
...
| Element | Type | Mandatory / Optional | Length | Comments | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AccountID | int |
| - | Owner of this address entity in the OneFlo database. | ||||||
| AddressID | int |
| - | The record ID of this address entity. | ||||||
| ATL | bool |
| - | 1/0 : Indicates if the receiver allows ATL (Authority to Leave), when a carrier is allowed to leave the parcel/freight without signature. | ||||||
| Name | string |
| 50 | Entity or Company name. Could be the name of the person receiving the freight. | ||||||
| Line1 | string |
| 30 | First line of the address. Must be provided so it appears on the label + postback. | ||||||
| Line2 | string |
| 30 | Additional line, when required. Will appear on label + postback. | ||||||
| Line3 | string |
| 30 | Extra line. Most carrier labels don't render this. | ||||||
| LocationID | int |
| - | 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 |
| 20 | Name of person / contact for this address entity. Will appear on label. | ||||||
| Phone | string |
| 15 | Phone number of contact. Will appear on Label. | ||||||
| string |
| 50 | Email address of contact. When populated in Consignment.Receiver, this will be used to deliver ASNs. | |||||||
| Fax | string |
| 15 | |||||||
| AddressLocation | Location |
| 0...1 | No need to define this element if the LocationID or LocationDetails element is provided. | ||||||
| LocationDetails | Location |
| 0...1 | No need to define this element if the LocationID or AddressLocation element is provided. | ||||||
| ModifiedBy | int |
| - | UserID as defined in the session. | ||||||
| State | string |
| 5 | Not recommended for use. | ||||||
| Suburb | string |
| 50 | Not recommended for use. | ||||||
| Exception | SaveException |
| - | Output. Provides detail on the result if there is an error with the data provided. |
...