Website logo

Remove a sale from your sold items list

Hides a listing from the sold items list.

URL: https://api.trademe.co.nz/v1/MyTradeMe/SoldItems/{purchaseId}.{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

purchaseId Integer (required)

The ID of the purchase to hide. Do not include a "P" prefix.

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

Returns

<HideMyTradeMeResponse>

Details on whether the operation was successful. Note that this operation will only report failure if the sale still exists in the sold items list after the operation completes. In all other cases, this API will report success (for example it will report success if the purchase ID is invalid or the sale has already been removed).

Success Boolean

Indicates whether the operation was successful.

Description String or null

The description of the error, if the operation failed.

Example XML Response (switch to JSON)

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

Example JSON Response (switch to XML)

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