Website logo

Send a complaint about an auction

Sends a complaint about a listing to the Trade Me customer service team.

URL: https://api.trademe.co.nz/v1/listings/{listingId}/sendcomplaint.{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

listingId Integer (required)

The ID of the auction the complaint is about.

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

POST Data

<ComplaintRequest>

SubjectId Integer (required)

The ID of the complaint subject line. This should be sourced from the retrieve complaint subjects API.

Body String (optional)

Free text field that should contain more details about the complaint. Optional.

Returns

<ComplaintResponse>

Information on 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.

Example XML Request (switch to JSON)

<ComplaintRequest xmlns="http://api.trademe.co.nz/v1">
  <SubjectId>123</SubjectId>
  <Body>ABC</Body>
</ComplaintRequest>

Example JSON Request (switch to XML)

{
  "SubjectId": 123,
  "Body": "ABC"
}

Example XML Response (switch to JSON)

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

Example JSON Response (switch to XML)

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