Website logo

Remove leading bid

Removes the leading bid from an auction. To remove a bid, you must be the seller of the auction.

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

<RemoveBidRequest>

ListingId Long Integer (required)

The ID of the auction to remove the bid from. You must be logged in as the seller of the auction.

BidAmount Number (required)

The value of the bid to remove, in New Zealand dollars.

BidderId Integer (required)

The ID of the member who placed the bid.

Returns

<RemoveBidResponse>

Indicates whether or not the operation succeeded.

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)

<RemoveBidRequest xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <BidAmount>123.0</BidAmount>
  <BidderId>123</BidderId>
</RemoveBidRequest>

Example JSON Request (switch to XML)

{
  "ListingId": 123,
  "BidAmount": 123.0,
  "BidderId": 123
}

Example XML Response (switch to JSON)

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

Example JSON Response (switch to XML)

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