Website logo

Delete Courier Parcel by Id

Delete an existing Courier Parcel by Id

URL: https://api.trademe.co.nz/v1/MyTradeMe/CourierParcels/{courierParcelId}.{file_format}
HTTP Method: DELETE
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

courierParcelId Integer (required)

Id of the existing parcel
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<DeleteParcelResponse>

Details of whether the operation was successful.

Success Boolean

Indicates whether the operation was successful.
Description String or null

The description of the error, if the operation failed.
Code Enumeration

More information as to the result of the operation
OK 0

Parcel was successfully updated in our system
ParcelNotFound 1

The specified parcel does not exist
MemberIsNotSeller 2

This member is not the seller of this auction
ParcelIsSystemGenerated 3

This parcel is system generated and cannot be deleted

Example XML Response (switch to JSON) 

<DeleteParcelResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <Code>OK</Code>
</DeleteParcelResponse>

Example JSON Response (switch to XML) 

{
  "Success": false,
  "Description": "ABC",
  "Code": 0
}