POST api/Ship/CancelOrder

Use this method to cancel an order that has not shipped yet

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	None.
TrackingNumber	Tracking number used to identify shipment to cancel	string	None.
PersonWhoCancelled	The name of person cancelling the shipment	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "TrackingNumber": "sample string 2",
  "PersonWhoCancelled": "sample string 3"
}

application/xml, text/xml

Sample:

<CancelOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models">
  <PersonWhoCancelled>sample string 3</PersonWhoCancelled>
  <TrackingNumber>sample string 2</TrackingNumber>
  <UserGUID>sample string 1</UserGUID>
</CancelOrderParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CancelOrderResp

Name	Description	Type	Additional information
IsSuccessful	If true, then method call was successful	boolean	None.
ErrorMessage	Contains an error message is method call failed	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<CancelOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CancelOrderResp>