Website logo

Retrieve buyer offer negotiations for active listings

Retrieves buyer offer negotiations for active listings. Returns the full negotiation history (all offer statuses) for each listing where the authenticated user is the buyer.

URL: https://api.trademe.co.nz/v1/MyTradeMe/BuyerOffers.{file_format}
HTTP Method: GET
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.

Query String parameters

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.
photo_size Enumeration (optional)

The size of the images to return in the results. Defaults to Thumbnail.
Thumbnail

The thumbnail sized photo (always 85x64, with white borders).
List

The list view sized photo (scaled down to fit 160x120).
Medium

The medium sized photo (scaled down to fit 175x175).
Gallery

The gallery sized photo (scaled down to fit 233x176).
Large

The large sized photo (scaled down to fit 352x264).
FullSize

The full sized photo (scaled down to fit 670x502).
JobSearchCard

The SearchCard photo (scaled down to fit 670x502).
rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50.

Returns

<BuyerOfferListings>

A list of active listings with their offer negotiation history.

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.
Page Integer

The index of the current page of results (starts at 1).
PageSize Integer

The number of results in the current page.
List Collection of <BuyerOfferListing> or null

A list of the results in the current page.
ListingId Integer

The listing ID.
Title String or null

The title of the listing.
PictureHref String or null

The URL of the listing's primary photo.
ClosingDate DateTime

The closing date of the listing.
StartPrice Number

The start price of the listing.
ActiveOfferCount Integer

The number of active (non-expired, non-declined) offers on this listing.
HasCounterOffer Boolean

Whether there is an active counter-offer from the seller.
PickupLocation String or null

The pickup location for the listing.
Offers Collection of <BuyerOfferDetail> or null

The full offer negotiation history for this listing.
OfferId Integer

The ID of the offer.
OfferPrice Number

The price offered.
IsCounterOffer Boolean

Whether this offer is a counter-offer from the seller.
Status String or null

The current status of the offer (e.g. Created, Declined, Expired).
CreatedDate DateTime

The date the offer was created.
LastModifiedDate DateTime

The date the offer was last modified.
ExpireDate DateTime

The date the offer expires.
PaymentMethodId Integer

The ID of the payment method selected for this offer.
ShippingOption Integer

The shipping option ID selected for this offer.
ShippingMethod String or null

The name of the delivery method (e.g. "NZ Courier", "Rural Delivery"). Only applicable if ShippingType is Custom.
ShippingPrice Number

The price of the delivery option. Only applicable if ShippingType is Custom. Rounded up to the nearest 2 decimal places.
ShippingType Enumeration

The type of delivery.
None 0

The type of the "None of the options apply to me" shipping option. Do not use when listing an item.
Unknown 0

Obsolete. Do not use.
Undecided 1

Indicates that the seller will confirm the shipping details with the buyer directly. This shipping option cannot be used when Pay Now is specified as a payment option. When listing an item, this option cannot be used in combination with other shipping options.
Pickup 2

Indicates the item can be picked up. Do not use when listing an item (use the Pickup field instead).
Free 3

Indicates the item can be shipped for free within New Zealand. When listing an item, this option cannot be used in combination with other shipping options.
Custom 4

Custom shipping option. Allows the seller to specify the price and description. Multiple custom shipping options are allowed (up to ten).
TradeMe 5

Trademe shipping option. Allows the seller to calculate the quotes from couriers, all calculated quotes will be saved in custom shipping options.
OfferBuyerFeeLine String or null

The buyer fee line item if it applies to this offer.

Example XML Response (switch to JSON) 

<BuyerOfferListings xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <BuyerOfferListing>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <PictureHref>ABC</PictureHref>
      <ClosingDate>2018-01-01T00:00:00Z</ClosingDate>
      <StartPrice>123.0</StartPrice>
      <ActiveOfferCount>123</ActiveOfferCount>
      <HasCounterOffer>false</HasCounterOffer>
      <PickupLocation>ABC</PickupLocation>
      <Offers>
        <BuyerOfferDetail>
          <OfferId>123</OfferId>
          <OfferPrice>123.0</OfferPrice>
          <IsCounterOffer>false</IsCounterOffer>
          <Status>ABC</Status>
          <CreatedDate>2018-01-01T00:00:00Z</CreatedDate>
          <LastModifiedDate>2018-01-01T00:00:00Z</LastModifiedDate>
          <ExpireDate>2018-01-01T00:00:00Z</ExpireDate>
          <PaymentMethodId>123</PaymentMethodId>
          <ShippingOption>123</ShippingOption>
          <ShippingMethod>ABC</ShippingMethod>
          <ShippingPrice>123.0</ShippingPrice>
          <ShippingType>None</ShippingType>
          <OfferBuyerFeeLine>ABC</OfferBuyerFeeLine>
        </BuyerOfferDetail>
        <BuyerOfferDetail>
          <OfferId>123</OfferId>
          <OfferPrice>123.0</OfferPrice>
          <IsCounterOffer>false</IsCounterOffer>
          <Status>ABC</Status>
          <CreatedDate>2018-01-01T00:00:00Z</CreatedDate>
          <LastModifiedDate>2018-01-01T00:00:00Z</LastModifiedDate>
          <ExpireDate>2018-01-01T00:00:00Z</ExpireDate>
          <PaymentMethodId>123</PaymentMethodId>
          <ShippingOption>123</ShippingOption>
          <ShippingMethod>ABC</ShippingMethod>
          <ShippingPrice>123.0</ShippingPrice>
          <ShippingType>None</ShippingType>
          <OfferBuyerFeeLine>ABC</OfferBuyerFeeLine>
        </BuyerOfferDetail>
      </Offers>
    </BuyerOfferListing>
    <BuyerOfferListing>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <PictureHref>ABC</PictureHref>
      <ClosingDate>2018-01-01T00:00:00Z</ClosingDate>
      <StartPrice>123.0</StartPrice>
      <ActiveOfferCount>123</ActiveOfferCount>
      <HasCounterOffer>false</HasCounterOffer>
      <PickupLocation>ABC</PickupLocation>
      <Offers>
        <BuyerOfferDetail>
          <OfferId>123</OfferId>
          <OfferPrice>123.0</OfferPrice>
          <IsCounterOffer>false</IsCounterOffer>
          <Status>ABC</Status>
          <CreatedDate>2018-01-01T00:00:00Z</CreatedDate>
          <LastModifiedDate>2018-01-01T00:00:00Z</LastModifiedDate>
          <ExpireDate>2018-01-01T00:00:00Z</ExpireDate>
          <PaymentMethodId>123</PaymentMethodId>
          <ShippingOption>123</ShippingOption>
          <ShippingMethod>ABC</ShippingMethod>
          <ShippingPrice>123.0</ShippingPrice>
          <ShippingType>None</ShippingType>
          <OfferBuyerFeeLine>ABC</OfferBuyerFeeLine>
        </BuyerOfferDetail>
        <BuyerOfferDetail>
          <OfferId>123</OfferId>
          <OfferPrice>123.0</OfferPrice>
          <IsCounterOffer>false</IsCounterOffer>
          <Status>ABC</Status>
          <CreatedDate>2018-01-01T00:00:00Z</CreatedDate>
          <LastModifiedDate>2018-01-01T00:00:00Z</LastModifiedDate>
          <ExpireDate>2018-01-01T00:00:00Z</ExpireDate>
          <PaymentMethodId>123</PaymentMethodId>
          <ShippingOption>123</ShippingOption>
          <ShippingMethod>ABC</ShippingMethod>
          <ShippingPrice>123.0</ShippingPrice>
          <ShippingType>None</ShippingType>
          <OfferBuyerFeeLine>ABC</OfferBuyerFeeLine>
        </BuyerOfferDetail>
      </Offers>
    </BuyerOfferListing>
  </List>
</BuyerOfferListings>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ListingId": 123,
      "Title": "ABC",
      "PictureHref": "ABC",
      "ClosingDate": "\/Date(1514764800)\/",
      "StartPrice": 123.0,
      "ActiveOfferCount": 123,
      "HasCounterOffer": false,
      "PickupLocation": "ABC",
      "Offers": [
        {
          "OfferId": 123,
          "OfferPrice": 123.0,
          "IsCounterOffer": false,
          "Status": "ABC",
          "CreatedDate": "\/Date(1514764800)\/",
          "LastModifiedDate": "\/Date(1514764800)\/",
          "ExpireDate": "\/Date(1514764800)\/",
          "PaymentMethodId": 123,
          "ShippingOption": 123,
          "ShippingMethod": "ABC",
          "ShippingPrice": 123.0,
          "ShippingType": 0,
          "OfferBuyerFeeLine": "ABC"
        },
        {
          "OfferId": 123,
          "OfferPrice": 123.0,
          "IsCounterOffer": false,
          "Status": "ABC",
          "CreatedDate": "\/Date(1514764800)\/",
          "LastModifiedDate": "\/Date(1514764800)\/",
          "ExpireDate": "\/Date(1514764800)\/",
          "PaymentMethodId": 123,
          "ShippingOption": 123,
          "ShippingMethod": "ABC",
          "ShippingPrice": 123.0,
          "ShippingType": 0,
          "OfferBuyerFeeLine": "ABC"
        }
      ]
    },
    {
      "ListingId": 123,
      "Title": "ABC",
      "PictureHref": "ABC",
      "ClosingDate": "\/Date(1514764800)\/",
      "StartPrice": 123.0,
      "ActiveOfferCount": 123,
      "HasCounterOffer": false,
      "PickupLocation": "ABC",
      "Offers": [
        {
          "OfferId": 123,
          "OfferPrice": 123.0,
          "IsCounterOffer": false,
          "Status": "ABC",
          "CreatedDate": "\/Date(1514764800)\/",
          "LastModifiedDate": "\/Date(1514764800)\/",
          "ExpireDate": "\/Date(1514764800)\/",
          "PaymentMethodId": 123,
          "ShippingOption": 123,
          "ShippingMethod": "ABC",
          "ShippingPrice": 123.0,
          "ShippingType": 0,
          "OfferBuyerFeeLine": "ABC"
        },
        {
          "OfferId": 123,
          "OfferPrice": 123.0,
          "IsCounterOffer": false,
          "Status": "ABC",
          "CreatedDate": "\/Date(1514764800)\/",
          "LastModifiedDate": "\/Date(1514764800)\/",
          "ExpireDate": "\/Date(1514764800)\/",
          "PaymentMethodId": 123,
          "ShippingOption": 123,
          "ShippingMethod": "ABC",
          "ShippingPrice": 123.0,
          "ShippingType": 0,
          "OfferBuyerFeeLine": "ABC"
        }
      ]
    }
  ]
}