Website logo

Relist an item

Relist an item that has expired. Relists an item without modifying editable fields.

Relist copies all data from original listing and applies them to the new listing. The only exceptions are where there are default durations that are applied on relisted items.

Some categories are currently unsupported (including subcategories): 98 (Livestock), 1349 (Horses).

URL: https://api.trademe.co.nz/v1/Selling/Relist.{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

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

POST Data

<RelistListingRequest>

ListingId Long Integer (required)

The ID of the listing that is being withdrawn, relisted or extended.

ReturnListingDetails Boolean (optional)

Indicates whether full listing details should be returned in the Listing field.

Returns

<ListingResponse>

Success Boolean

Indicates whether the operation was successful.

Description String or null

The description of the error, if the operation failed.

ListingId Long Integer

The ID of the listing.

Listing <ListedItemDetail> or null

The state of the listing, after the listing operation has successfully completed. This field is only present if the ReturnListingDetails parameter is true and the operation was successful. This field will also be missing if there was an error retrieving the listing details. For more information on this field, see the documentation for the listing details API.

(This type is defined elsewhere)
ListingGroupId Long Integer or null

The identifier of the group of related multi-variant listings. Blank if the listing is not multi-variant

Variants Collection of <Variant> or null

The individual variants created in the group of related multi-variant listings.

(This type has already been defined)

Example XML Request (switch to JSON)

<RelistListingRequest xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <ReturnListingDetails>false</ReturnListingDetails>
</RelistListingRequest>

Example JSON Request (switch to XML)

{
  "ListingId": 123,
  "ReturnListingDetails": false
}

Example XML Response (switch to JSON)

<ListingResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <ListingId>123</ListingId>
  <Listing> ... </Listing>
  <ListingGroupId>123</ListingGroupId>
  <Variants>
    <Variant />
    <Variant />
  </Variants>
</ListingResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "Description": "ABC",
  "ListingId": 123,
  "Listing": { ... },
  "ListingGroupId": 123,
  "Variants": [
    {
    },
    {
    }
  ]
}