Website logo

Place a bid

Place a bid (normal or auto-bid) on a listing.

URL: https://api.trademe.co.nz/v1/bidding/bid.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: BiddingAndBuying: Place bids, and complete purchases using Buy Now & Fixed Price Offers.
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

<BidRequest>

ListingId Integer (required) ListingId
Amount Number (required) Amount
AutoBid Boolean (required) AutoBid
ShippingOption Integer (required) ShippingOption
EmailOutBid Boolean (optional) EmailOutBid
FirearmsLicence String (optional) FirearmsLicence
FirearmsLicenceHolder <FirearmsLicenceHolderDetails> (optional) FirearmsLicenceHolder
FirstName String (required) FirstName
MiddleNames String (optional) MiddleNames
LastName String (required) LastName
IsBuyerOlderThan18 Boolean (optional) IsBuyerOlderThan18
ReturnListingDetails Boolean (optional) ReturnListingDetails
ReferringSearchQueryId String (optional) ReferringSearchQueryId

Returns

<AuctionBidResponse>

The details of the bid.

Success Boolean Success
Description String or null Description
IsTooHigh Boolean IsTooHigh
IsTooLow Boolean IsTooLow
IsReserveMet Boolean IsReserveMet
MinimumNextBid Number MinimumNextBid
StatusCode Enumeration StatusCode
Success 0 Success
None 1 None
ReserveMet 2 ReserveMet
ErrorAccountDisabled 3 ErrorAccountDisabled
ReserveNotMet 4 ReserveNotMet
ErrorBadMemberDetails 5 ErrorBadMemberDetails
ReserveMetAutoBidGreaterThanReserve 6 ReserveMetAutoBidGreaterThanReserve
ErrorHeavyQuarantine 7 ErrorHeavyQuarantine
ReserveMetAutoBidIncreased 8 ReserveMetAutoBidIncreased
ReserveNotMetAutoBid 9 ReserveNotMetAutoBid
ReserveMetExistingAutoBidGreaterThanBid 10 ReserveMetExistingAutoBidGreaterThanBid
ErrorOwnAuction 11 ErrorOwnAuction
ReserveNotMetExistingAutoBidGreaterThanBid 12 ReserveNotMetExistingAutoBidGreaterThanBid
ErrorBlacklisted 13 ErrorBlacklisted
ReserveMetExistingAutoBidEqualToBid 14 ReserveMetExistingAutoBidEqualToBid
ErrorAuthenticatedMembersOnlyAuction 15 ErrorAuthenticatedMembersOnlyAuction
ReserveNotMetExistingAutoBidEqualToBid 16 ReserveNotMetExistingAutoBidEqualToBid
ErrorAccountIndebt 17 ErrorAccountIndebt
ReserveMetAutoBid 18 ReserveMetAutoBid
ErrorBidTooHigh 19 ErrorBidTooHigh
ErrorBidLessThanMinimumNextBid 21 ErrorBidLessThanMinimumNextBid
ErrorBidLessThanFiftyCents 23 ErrorBidLessThanFiftyCents
ErrorBidLessThanStartPrice 25 ErrorBidLessThanStartPrice
ErrorTooManyBids 27 ErrorTooManyBids
ErrorHasTopAutoBid 29 ErrorHasTopAutoBid
ErrorAuctionClosed 30 ErrorAuctionClosed
ErrorDatabase 31 ErrorDatabase
ErrorListingAcceptsBuyNowOnly 34 ErrorListingAcceptsBuyNowOnly
ErrorQuantityInvalid 35 ErrorQuantityInvalid
ErrorListingIsAClassified 36 ErrorListingIsAClassified
ErrorInvalidShipping 37 ErrorInvalidShipping
ErrorInvalidFirearmsLicense 38 ErrorInvalidFirearmsLicense
ErrorAgeConfirmationRequired 39 ErrorAgeConfirmationRequired
ErrorListingAcceptsPayNowOnly 40 ErrorListingAcceptsPayNowOnly
ErrorBuyProcessBan 41 ErrorBuyProcessBan
AutoBidDecreased 42 AutoBidDecreased
Listing <ListedItemDetail> or null Listing
(This type is defined elsewhere)
CurrentAutoBid Number or null CurrentAutoBid

Example XML Request (switch to JSON)

<BidRequest xmlns="http://api.trademe.co.nz/v1">
  <ListingId>123</ListingId>
  <Amount>123.0</Amount>
  <AutoBid>false</AutoBid>
  <ShippingOption>123</ShippingOption>
  <EmailOutBid>false</EmailOutBid>
  <FirearmsLicence>ABC</FirearmsLicence>
  <FirearmsLicenceHolder>
    <FirstName>ABC</FirstName>
    <MiddleNames>ABC</MiddleNames>
    <LastName>ABC</LastName>
  </FirearmsLicenceHolder>
  <IsBuyerOlderThan18>false</IsBuyerOlderThan18>
  <ReturnListingDetails>false</ReturnListingDetails>
  <ReferringSearchQueryId>ABC</ReferringSearchQueryId>
</BidRequest>

Example JSON Request (switch to XML)

{
  "ListingId": 123,
  "Amount": 123.0,
  "AutoBid": false,
  "ShippingOption": 123,
  "EmailOutBid": false,
  "FirearmsLicence": "ABC",
  "FirearmsLicenceHolder": {
    "FirstName": "ABC",
    "MiddleNames": "ABC",
    "LastName": "ABC"
  },
  "IsBuyerOlderThan18": false,
  "ReturnListingDetails": false,
  "ReferringSearchQueryId": "ABC"
}

Example XML Response (switch to JSON)

<AuctionBidResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <IsTooHigh>false</IsTooHigh>
  <IsTooLow>false</IsTooLow>
  <IsReserveMet>false</IsReserveMet>
  <MinimumNextBid>123.0</MinimumNextBid>
  <StatusCode>Success</StatusCode>
  <Listing> ... </Listing>
  <CurrentAutoBid>123.0</CurrentAutoBid>
</AuctionBidResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "Description": "ABC",
  "IsTooHigh": false,
  "IsTooLow": false,
  "IsReserveMet": false,
  "MinimumNextBid": 123.0,
  "StatusCode": 0,
  "Listing": { ... },
  "CurrentAutoBid": 123.0
}