Retrieve a note

Retrieves the note for a listing, if there is one.

URL:	https://api.trademe.co.nz/v1/MyTradeMe/Notes/{listingId}.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	MyTradeMeRead: Read your membership & listing data.
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

listingId

String (required)

The ID of the listing to retrieve the note for.

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Query String parameters

is_purchase_id	Boolean (optional)	Indicates whether the listing ID is actually a purchase ID. Defaults to false.
offer_id	Integer (optional)	The ID of the offer associated with the note. Defaults to 0, which indicates the note to retrieve is not associated with a fixed price offer.

Returns

Whether the operation was successful and the note details.

Success	Boolean	Indicates whether the operation was successful.
Description	String or null	The description of the error, if the operation failed.
NoteId	Integer	The ID of the note.
Text	String or null	The note text.
OfferId	Integer	The ID of the fixed price offer, or 0 if the note is not associated with a fixed price offer.

Example XML Response (switch to JSON)

<NoteResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <NoteId>123</NoteId>
  <Text>ABC</Text>
  <OfferId>123</OfferId>
</NoteResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "Description": "ABC",
  "NoteId": 123,
  "Text": "ABC",
  "OfferId": 123
}