| Name | Description | Type | Additional information |
|---|---|---|---|
| ShipDate |
The Ship/Pickup date returned by carrier |
date |
None. |
| Packages |
Array of shipment Packages |
Collection of WS_Repository.Models.Requests.Ship.Package |
None. |
| ShipmentReference |
Shipment Reference |
string |
None. |
| ShipmentReference2 |
Shipment Reference 2 |
string |
None. |
| ShipmentPONumber |
Shipment PO Number |
string |
None. |
| Sender |
Sender Contact |
WS_Repository.Models.Requests.Ship.Contact |
None. |
| Recipient |
Recipient Contact |
WS_Repository.Models.Requests.Ship.Contact |
None. |
| ConsolidationUnit |
Consolidation Unit - indicates that the shipments belong to a Consolidation Unit |
WS_Repository.Models.Responses.Ship.ConsolidationUnit |
None. |
| PickupNumber |
Pickup Number |
string |
None. |
| PickupCarrierLocationCode |
Pickup Carrier Location Code |
string |
None. |
| PickupErrorMessage |
Pickup Error Message |
string |
None. |
| Contents |
Contents of the shipment packages |
WS_Repository.Models.Responses.Ship.Contents |
None. |
| Billing |
(Optional) used to rate/ship with other account |
WS_Repository.Models.Requests.Ship.BillingOptions |
None. |
| GLCategory |
General Ledger Category |
string |
None. |
| GLSubCategory |
General Ledger sub Category |
string |
None. |
| DepartmentDescription |
Department Description |
string |
None. |
| DepartmentCode |
Department Code |
string |
None. |
| AggregatedOrderNumbers |
Return all the aggregated Order Numbers |
Collection of string |
None. |
| AggregationId |
Aggregation Id - it specify if the order was aggregated with other orders in Onhold - all the aggregated orders are listed in AggregatedOrderNumbers field |
string |
None. |
| IsReturn |
This shipment is a return |
boolean |
None. |
| OriginalShipmentInfo |
When this shipment is a return it may have Information about Original Shipment (Shipment Id and Tracking Number) |
WS_Repository.Models.Responses.Ship.OriginalShipmentInfo |
None. |
| LabelGenerationDate |
Label Generation Date |
date |
None. |
| ExternalOrderIdentifier |
Optional information supplied in the hold request |
string |
None. |
| AggregatedExternalOrderIdentifiers |
Return all the aggregated orders external ids |
Collection of string |
None. |
| CustomField1 |
Custom Field 1 |
string |
None. |
| CustomField2 |
Custom Field 2 |
string |
None. |
| CustomField3 |
Custom Field 3 |
string |
None. |
| CustomField4 |
Custom Field 4 |
string |
None. |
| CustomField5 |
Custom Field 5 |
string |
None. |
| ActualDeliveryDate |
If the shipment is delivered it specify the delivery date |
date |
None. |
| ExpectedDeliveryDate |
if the shipment is not delivered it specify the expected delivery date |
date |
None. |