POST api/Cancel

Allows cancelling a parcel using its tracking number

Parameters

* Required
Property Description
TrackingNumber (String)
*  Parcel's Tracking Number
UserNotes (String)
Cancellation Notes
Key (Guid)
* Your i-parcel API key (visible in your Dashboard via the Integrate link.)

Request body formats

application/json, text/json

Sample:
{
  "TrackingNumber": "sample string 1",
  "UserNotes": "sample string 2",
  "Key": "2e831751-2368-4b88-b436-031fb4a594dd"
}

application/xml, text/xml

Sample:
<CancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebRequest">
  <Key>2e831751-2368-4b88-b436-031fb4a594dd</Key>
  <TrackingNumber>sample string 1</TrackingNumber>
  <UserNotes>sample string 2</UserNotes>
</CancelRequest>

Response Information

You will get back a Code, a Message describing the outcome of the process, and an alphanumeric string which identifies the transaction

Response body formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Code": 2,
  "Transaction": "sample string 3"
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalAccessLibrary.Models.WebResponse">
  <Code>2</Code>
  <Message>sample string 1</Message>
  <Transaction>sample string 3</Transaction>
</ApiResponse>