| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipmentId |
Unique identifier for shipment |
string |
None. |
| QuoteId |
Quote Id |
string |
None. |
| IsCancelled |
Is Cancelled |
boolean |
None. |
| Carrier |
Provide carrier details to make shipment from that carrier. |
CarrierV3 |
None. |
| Rate |
Shipment rate details |
ShipmentRate |
None. |
| PaymentTerm |
Shipment payment terms |
PaymentTerm |
None. |
| ThirdPartyAccountInfo |
Third party account details |
AccountDetails |
None. |
| ShipDate |
Ship date in UTC |
date |
None. |
| ShipperAddress |
Shipper address |
Address |
None. |
| ReturnAddress |
Return Address |
Address |
None. |
| ConsigneeAddress |
Consignee address |
Address |
None. |
| TruckLoadStops | Collection of TruckLoadStop |
None. |
|
| ITN |
International transaction number |
string |
None. |
| Reference1 |
Reference 1 |
string |
None. |
| Reference2 |
Referece 2 |
string |
None. |
| Reference3 |
Reference 3 |
string |
None. |
| Reference4 |
Referece 4 |
string |
None. |
| Reference5 |
Referece 5 |
string |
None. |
| Reference6 |
Referece 6 |
string |
None. |
| Items |
Shipment Items |
Collection of ShipmentItemDtoV3 |
None. |
| ProductDetails |
Product details |
Collection of ProductDetailV3 |
None. |
| AdditionalDetails |
Additional details |
ShipmentAdditionalDetailsV3 |
None. |
| PickupNumber |
Pickup number of a shipment |
string |
None. |
| PickupDetails |
Pickup details |
ShipmentPickupDetails |
None. |
| Documents |
Shipment documents i.e. BOL, Labels, Packing slips etc |
Collection of DocumentV2 |
None. |
| TrackingNumbers |
Tracking number of a shipment |
Collection of string |
None. |
| TrackingURLs |
Tracking URLs of a shipment |
Collection of string |
None. |
| ReadyTime |
Ready Time For Shipment |
string |
None. |
| CutOffTime |
Cut Off Time for Shipment |
string |
None. |
| QuoteFrom |
This describes from where the quote is generated |
QuoteFrom |
None. |
| OrderNumber |
Order Number against which shipment is created |
string |
None. |
| ConsolidatedOrderNumber |
Consolidated Order Number. The order number that is generated when two orders are consolidated |
string |
None. |
| Status |
Shipment Status |
string |
None. |
| IsBroker |
IsBroker |
boolean |
None. |
|
|
string |
None. |
|
| TotalMiles |
Total Miles |
integer |
None. |