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 Long 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

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).

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

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 <FixedPriceOffer> or null

A list of the results in the current page.

OfferPrice Number

The offer price of the item on offer. For offers with more than one available item, this is the price per item. The price for shipping is not included.

OfferExpiryDate DateTime

The date and time the fixed price offer expires.

Quantity Integer

The number of items that are available. Buyers are able to purchase one or more of this item until the stock runs out or the offer ends.

ListingId Long Integer

The listing ID of the item on offer.

Title String or null

The title of the item on offer.

StartDate DateTime

The date and time the auction started.

EndDate DateTime

The date and time the auction ended.

BidCount Integer

The number of bids placed on the auction.

Mcat String or null

The identifier of the category the item is listing in.

PictureHref String or null

The URL of the thumbnail photo.

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"
    }
  ]
}