GET api/orders/{OrderNumber}/validateCancelShipment/{ShipmentId}

Validates that a shipment is eligble for cancelling.

Request Information

URI Parameters

Name	Description	Type	Additional information
OrderNumber	Work order number	integer	Required
ShipmentId	Shipment number	integer	Required

Body Parameters

None.

Response Information

Resource Description

A structure indicating the validity of a shipment with respect to its readiness to cancel.

ShipmentCancellationValidationResponse

Name	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.	ShipmentCancellationValidationFailure	None.

Response Formats

application/json, text/json

Sample:

{
  "ValidationToken": "sample string 1",
  "Issues": 0
}

application/xml, text/xml

Sample:

<ShipmentCancellationValidationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ValidationToken>sample string 1</ValidationToken>
  <Issues>None</Issues>
</ShipmentCancellationValidationResponse>