Website logo

Promote a listing with a temporal extra

Promote a listing with a Temporal (time based) Extra.

Boost and Super Feature renewal are no longer available on their own for rental listings from a property agent, because both are included in the rental premium packages. For those requests this call still returns success, but nothing is applied and nothing is charged; the response description says so. Where the agent's rental Partnership Agreement already carries Super Feature, the description says that instead. Every other member and category is unaffected.

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

<ListingTemporalExtraPromotionRequest>

ListingId Integer (required)

The id of the listing to promote
Extra Enumeration (required)

The extra to promote the listing with
Boost 0

Boost a Listing so it appears higher in search results
RenewSuperFeature 1

Renew expiring Super Feature.

Returns

<ListingTemporalExtraPromotionResponse>

Success Boolean

Indicates whether the operation was successful.
Description String or null

The description of the error, if the operation failed.
ListingId Integer

The ID of the listing.

Example XML Request (switch to JSON) 

<ListingTemporalExtraPromotionRequest xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <Extra>Boost</Extra>
</ListingTemporalExtraPromotionRequest>

Example JSON Request (switch to XML) 

{
  "ListingId": 123,
  "Extra": 0
}

Example XML Response (switch to JSON) 

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

Example JSON Response (switch to XML) 

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