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 Success
Description String or null Description
Code Enumeration Code
OK 0 OK
ParcelNotFound 1 ParcelNotFound
MemberIsNotSeller 2 MemberIsNotSeller
ParcelIsSystemGenerated 3 ParcelIsSystemGenerated

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
}