Website logo

Get a list of draft listings

Get all saved draft listings for member

URL: https://api.trademe.co.nz/v1/Selling/Drafts.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

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

Returns

<DraftListingResponse>

Success Boolean

Indicates whether the operation was successful.

StatusCode Enumeration

The draft listing request status.

Success 0

The operation was successful.

MaxLimitExceeded 1

Max draft limit exceeded failure.

Drafts Collection of <Draft> or null

All saved drafts.

DraftId Integer

The ID of the draft listing.

Name String or null

The name of the draft listing.

Note String or null

An additional note for the draft listing.

Listing <ListingRequest> or null

The draft listing data.

Example XML Response (switch to JSON)

<DraftListingResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <StatusCode>Success</StatusCode>
  <Drafts>
    <Draft>
      <DraftId>123</DraftId>
      <Name>ABC</Name>
      <Note>ABC</Note>
      <Listing />
    </Draft>
    <Draft>
      <DraftId>123</DraftId>
      <Name>ABC</Name>
      <Note>ABC</Note>
      <Listing />
    </Draft>
  </Drafts>
</DraftListingResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "StatusCode": 0,
  "Drafts": [
    {
      "DraftId": 123,
      "Name": "ABC",
      "Note": "ABC",
      "Listing": {
      }
    },
    {
      "DraftId": 123,
      "Name": "ABC",
      "Note": "ABC",
      "Listing": {
      }
    }
  ]
}