Website logo

Retrieve the fixed price offers you have made to others

Retrieves a list of the active fixed price offers that have been made by the currently authenticated user.

Only active offers are returned. A fixed price offer is active if it has not expired, has not been accepted and has not been rejected by all participants.

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

listing_id Integer (optional)

Filters the results to the offers for a single listing. Currently a listing can only have a single offer.
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 Thumbnail
List List
Medium Medium
Gallery Gallery
Large Large
FullSize FullSize
JobSearchCard JobSearchCard
rows Integer (optional)

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

Returns

<FixedPriceOffers>

A list of active fixed price offers.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <FixedPriceOffer> or null InnerList
OfferPrice Number OfferPrice
OfferExpiryDate DateTime OfferExpiryDate
Quantity Integer Quantity
ListingId Integer ListingId
Title String or null Title
StartDate DateTime StartDate
EndDate DateTime EndDate
BidCount Integer BidCount
Mcat String or null Mcat
PictureHref String or null PictureHref

Example XML Response (switch to JSON) 

<FixedPriceOffers xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <FixedPriceOffer>
      <OfferPrice>123.0</OfferPrice>
      <OfferExpiryDate>2018-01-01T00:00:00Z</OfferExpiryDate>
      <Quantity>123</Quantity>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <BidCount>123</BidCount>
      <Mcat>ABC</Mcat>
      <PictureHref>ABC</PictureHref>
    </FixedPriceOffer>
    <FixedPriceOffer>
      <OfferPrice>123.0</OfferPrice>
      <OfferExpiryDate>2018-01-01T00:00:00Z</OfferExpiryDate>
      <Quantity>123</Quantity>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <BidCount>123</BidCount>
      <Mcat>ABC</Mcat>
      <PictureHref>ABC</PictureHref>
    </FixedPriceOffer>
  </List>
</FixedPriceOffers>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "OfferPrice": 123.0,
      "OfferExpiryDate": "\/Date(1514764800)\/",
      "Quantity": 123,
      "ListingId": 123,
      "Title": "ABC",
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "BidCount": 123,
      "Mcat": "ABC",
      "PictureHref": "ABC"
    },
    {
      "OfferPrice": 123.0,
      "OfferExpiryDate": "\/Date(1514764800)\/",
      "Quantity": 123,
      "ListingId": 123,
      "Title": "ABC",
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "BidCount": 123,
      "Mcat": "ABC",
      "PictureHref": "ABC"
    }
  ]
}