Website logo

Save or update the status of a listing using a purchase ID

Saves a status to a listing in the authenticated user's Sold Items list.

URL: https://api.trademe.co.nz/v1/MyTradeMe/Status/{purchaseId}/{stat}.{file_format}
HTTP Method: POST
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.
stat String (required)

The status you want to save, should be one of the following: EmailSent, PaymentReceived, GoodsShipped, SaleCompleted.
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<StatusResponse>

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.
Status String or null

The id of the status

Example XML Response (switch to JSON) 

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

Example JSON Response (switch to XML) 

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