GET api/orders/{OrderNumber}/validateShipment/{ShipmentId}/{OverrideShippingProfileId}
Validates that a shipment is ready to ship.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
OrderNumber |
Work order number |
integer |
Required |
ShipmentId |
Shipment number |
integer |
Required |
OverrideShippingProfileId |
Shipping profile to use instead of the default |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A structure indicating the validity of a shipment with respect to its readiness to ship.
ShipmentValidationResponseName | Description | Type | Additional information |
---|---|---|---|
ValidationToken |
If successfully validated, a token to use to actually ship the shipment |
string |
None. |
Issues |
Indicates what is wrong with the shipment, if anything. |
ShipmentValidationFailure |
None. |
PackageIssues |
Indicates what is wrong with a particular package in a shipment, if anything. |
Dictionary of integer [key] and PackageValidationFailure [value] |
None. |
AvailableShipmentReadyWindows |
A list of available shipment ready windows. Times are local to the ship from location. |
Collection of TimeWindow |
None. |
Response Formats
application/json, text/json
{ "ValidationToken": "sample string 1", "Issues": 0, "PackageIssues": { "1": 0, "2": 0 }, "AvailableShipmentReadyWindows": [ { "WindowStart": "2024-12-25T08:46:47.7256091-05:00", "WindowEnd": "2024-12-25T08:46:47.7256091-05:00" }, { "WindowStart": "2024-12-25T08:46:47.7256091-05:00", "WindowEnd": "2024-12-25T08:46:47.7256091-05:00" } ] }