Website logo

Withdraw a fixed price offer

Withdraws an offer that is current and not expired, accepted or rejected by all users.

URL: https://api.trademe.co.nz/v1/FixedPriceOffers/WithdrawOffer.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
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

<FixedPriceOfferWithdrawalRequest>

ListingId 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

<FixedPriceOfferResponse>

Details on whether the operation was successful.

Success Boolean

Indicates whether the operation was successful.
Description String or null

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

The result code of the offer response.

This field is always zero. Do not use.

Example XML Request (switch to JSON) 

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

Example JSON Request (switch to XML) 

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

Example XML Response (switch to JSON) 

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

Example JSON Response (switch to XML) 

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