Website logo

Send an email to the seller

Sends a message to the seller of a classified via email. If possible, the listing will be added to the authenticated member's watchlist.

URL: https://api.trademe.co.nz/v1/Listings/{listingId}/EmailSeller.{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 listing the question is about.

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

POST Data

<EmailRequest>

Message String (required)

The message to send to the seller.

CopyToSelf Boolean (optional)

Indicates whether the message is copied to the sender.

PhoneNumber String (optional)

Phone number of enquirer; this is only available for Motors DealerBase listings and Property listings

EmailAddress String (optional)

Email of enquirer; this is only available for Motors DealerBase listings and Property listings

FirstName String (optional)

Fist name of enquirer; this is only available for Motors DealerBase listings and Property listings

LastName String (optional)

Last name of enquirer; this is only available for Property listings

EnquiryType Enumeration (optional)

The type of the enquiry. This is only available for Motors DealerBase listings, otherwise the field is ignored.

Unknown 0

Default option when the EnquiryType is not known

General 1

General question

Finance 2

Finance options for the listing

TradeIn 3

Questions about Trade-In of a vehicle

TestDrive 4

Questions about a Test Drive

ReferringSearchId String (optional)

The ID of the search event that led to the listing. This is only used for internal event tracking.

Returns

<EmailResponse>

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)

<EmailRequest xmlns="http://api.trademe.co.nz/v1">
  <Message>ABC</Message>
  <CopyToSelf>false</CopyToSelf>
  <PhoneNumber>ABC</PhoneNumber>
  <EmailAddress>ABC</EmailAddress>
  <FirstName>ABC</FirstName>
  <LastName>ABC</LastName>
  <EnquiryType>Unknown</EnquiryType>
  <ReferringSearchId>ABC</ReferringSearchId>
</EmailRequest>

Example JSON Request (switch to XML)

{
  "Message": "ABC",
  "CopyToSelf": false,
  "PhoneNumber": "ABC",
  "EmailAddress": "ABC",
  "FirstName": "ABC",
  "LastName": "ABC",
  "EnquiryType": 0,
  "ReferringSearchId": "ABC"
}

Example XML Response (switch to JSON)

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

Example JSON Response (switch to XML)

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