| Name | Description | Type | Additional information |
|---|---|---|---|
| CarrierId |
Carrier Id |
integer |
None. |
| CarrierName |
Carrier Name |
string |
None. |
| RateService |
Rate Service with cost |
WS_Repository.Models.Responses.Hold.OrderDetailsRateService |
None. |
| Sender |
Sender Contact |
WS_Repository.Models.Responses.Hold.Contact |
None. |
| Recipient |
Recipient Contact |
WS_Repository.Models.Responses.Hold.Contact |
None. |
| Packages |
Array of Package |
Collection of WS_Repository.Models.Responses.Hold.Package |
None. |
| Skids |
Array of Skids |
Collection of WS_Repository.Models.Responses.Hold.Skid |
None. |
| PackagesAreSkids |
If is set to true it specify that all the items in Packages will be treated as Skids |
boolean |
None. |
| ShipmentReference |
Shipment reference |
string |
None. |
| ShipmentReference2 |
Shipment reference 2 |
string |
None. |
| ShipmentPONumber |
Shipment PO number |
string |
None. |
| OrderNumber |
Your internal order number of the order |
string |
None. |
| IsAggregated |
Specify if the order is aggreggated with other orders |
boolean |
None. |
| AggregatedOrderNumbers |
Aggregated Order Numbers List - is available just when ShipStatus = "Shipped" and IsAggregated = true |
Collection of string |
None. |
| PartialShipStatus |
Partial Ship Status |
WS_Repository.Models.Responses.Hold.PartialShipStatusType |
None. |
| ShipStatus |
Order Status - specify if the order is still in onhold or it is shipped |
WS_Repository.Models.Responses.Hold.OrderStatusType |
None. |
| ShipDocs |
Shipping Documents - it is available just if ShipStatus = "Shipped" |
Collection of WS_Repository.Models.Responses.Ship.ShipDocument |
None. |
| CarrierType |
Total Customer Price |
WS_Repository.Models.Responses.Hold.CarrierType |
None. |
| ExternalOrderIdentifier |
Optional information supplied in the hold request |
string |
None. |
| AggregatedExternalOrderIdentifiers |
List of external ids information supplied in the hold requests of all aggregated orders |
Collection of string |
None. |
| WebhookType |
Webhook Type |
string |
None. |