| 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. |