Website logo

Respond to a fixed price offer

Accepts or rejects a fixed price offer. This API is identical to this one.

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

<FixedPriceOfferRequest>

ListingId Long Integer (required)

The ID of a listing which has a current fixed price offer associated with it.

Accept Boolean (required)

Indicates whether or not to accept or reject the fixed price offer.

ShippingOption Integer (optional)

The preferred shipping option which will be used when this request happens to be the winning bid. The value is an numeric ID that is returned from the listing detail request (in the ShippingId field). Required when accepting the offer.

Quantity Integer (optional)

Indicates the number of items to buy. Only applicable to Buy Now only auctions. Defaults to 1.

FirearmsLicence String (optional)

The user's firearms licence number. This is required for firearms purchases.

FirearmsLicenceHolder <FirearmsLicenceHolderDetails> (optional)

The user Enters First, Middle, and Last Names associated to the firearms licence.

FirstName String (required)

First name of License Holder. Required;

MiddleNames String (optional)

Middle Names of License Holder. Optional;

LastName String (required)

Last name of License Holder. Required;

ReturnListingDetails Boolean (optional)

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

IsBuyerOlderThan18 Boolean (optional)

The user agrees they are older than 18. This is required for wine purchases.

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.

PurchaseId Integer

The ID of the purchase (only available if the offer was accepted).

Example XML Request (switch to JSON)

<FixedPriceOfferRequest xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <Accept>false</Accept>
  <ShippingOption>123</ShippingOption>
  <Quantity>123</Quantity>
  <FirearmsLicence>ABC</FirearmsLicence>
  <FirearmsLicenceHolder>
    <FirstName>ABC</FirstName>
    <MiddleNames>ABC</MiddleNames>
    <LastName>ABC</LastName>
  </FirearmsLicenceHolder>
  <ReturnListingDetails>false</ReturnListingDetails>
  <IsBuyerOlderThan18>false</IsBuyerOlderThan18>
</FixedPriceOfferRequest>

Example JSON Request (switch to XML)

{
  "ListingId": 123,
  "Accept": false,
  "ShippingOption": 123,
  "Quantity": 123,
  "FirearmsLicence": "ABC",
  "FirearmsLicenceHolder": {
    "FirstName": "ABC",
    "MiddleNames": "ABC",
    "LastName": "ABC"
  },
  "ReturnListingDetails": false,
  "IsBuyerOlderThan18": false
}

Example XML Response (switch to JSON)

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

Example JSON Response (switch to XML)

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