POST api/Ship/CancelOrder

Request Information

URI Parameters

None.

Body Parameters

CancelOrderParm
NameDescriptionTypeAdditional information
UserGUID

string

None.

TrackingNumber

string

None.

PersonWhoCancelled

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.Shipper1.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
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

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.Shipper1.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CancelOrderResp>