Website logo

Retrieve your unreviewed fixed price offers

Retrieves a list of the outstanding fixed price offers that have been offered to the currently authenticated user.

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

<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.
TaxesIncluded Collection of <TaxRate> or null

The taxes included in the offer price
Type Enumeration

The type of tax that is included
NZ_GST_Overseas_Supplies 1

New Zealand GST on overseas supplies
Country String or null

The country that is levying the tax e.g. NZ
Name String or null

The name of the tax e.g. GST
FlatRate Number

The rate at which the tax is charged (as a decimal e.g 0.15)
Description String or null

A string that can be used as a caption where necessary
IsSellRestrictionsEffective Boolean

Whether certain features like auction, unspecified shipping, pickups, non hosted payment methods should be restricted
IsTaxEffective Boolean

Whether the effective date for the tax has been reached e.g. 1st Dec for NZ GST
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.
ShippingOptions Collection of <ShippingOption> or null

A list of shipping options for this fixed price offer.
Type 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.
Price Number

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

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

The ID of the shipping option (used when bidding or for Buy Now). Not required when listing an item.
TaxesIncluded Collection of <TaxRateOnPrice> or null

Indicates if taxes (and what type) are included in the Shipping Price
Type Enumeration

The type of tax that is included
NZ_GST_Overseas_Supplies 1

New Zealand GST on overseas supplies
Country String or null

The country that is levying the tax e.g. NZ
Name String or null

The name of the tax e.g. GST
FlatRate Number

The rate at which the tax is charged (as a decimal e.g 0.15)
Description String or null

A string that can be used as a caption where necessary
IsSellRestrictionsEffective Boolean

Whether certain features like auction, unspecified shipping, pickups, non hosted payment methods should be restricted
IsTaxEffective Boolean

Whether the effective date for the tax has been reached e.g. 1st Dec for NZ GST
IsApplied Boolean

Whether the price has had the tax applied (i.e. are inclusive prices)
TaxAmount Number or null

The amount of tax that was added to the price if applied
WasPriceTaxAmount Number or null

The amount of tax that was added to the was/now price if applied
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>
      <TaxesIncluded>
        <TaxRate>
          <Type>NZ_GST_Overseas_Supplies</Type>
          <Country>ABC</Country>
          <Name>ABC</Name>
          <FlatRate>123.0</FlatRate>
          <Description>ABC</Description>
          <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
          <IsTaxEffective>false</IsTaxEffective>
        </TaxRate>
        <TaxRate>
          <Type>NZ_GST_Overseas_Supplies</Type>
          <Country>ABC</Country>
          <Name>ABC</Name>
          <FlatRate>123.0</FlatRate>
          <Description>ABC</Description>
          <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
          <IsTaxEffective>false</IsTaxEffective>
        </TaxRate>
      </TaxesIncluded>
      <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>
      <ShippingOptions>
        <ShippingOption>
          <Type>None</Type>
          <Price>123.0</Price>
          <Method>ABC</Method>
          <ShippingId>123</ShippingId>
          <TaxesIncluded>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
          </TaxesIncluded>
        </ShippingOption>
        <ShippingOption>
          <Type>None</Type>
          <Price>123.0</Price>
          <Method>ABC</Method>
          <ShippingId>123</ShippingId>
          <TaxesIncluded>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
          </TaxesIncluded>
        </ShippingOption>
      </ShippingOptions>
      <PictureHref>ABC</PictureHref>
    </FixedPriceOffer>
    <FixedPriceOffer>
      <OfferPrice>123.0</OfferPrice>
      <OfferExpiryDate>2018-01-01T00:00:00Z</OfferExpiryDate>
      <Quantity>123</Quantity>
      <TaxesIncluded>
        <TaxRate>
          <Type>NZ_GST_Overseas_Supplies</Type>
          <Country>ABC</Country>
          <Name>ABC</Name>
          <FlatRate>123.0</FlatRate>
          <Description>ABC</Description>
          <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
          <IsTaxEffective>false</IsTaxEffective>
        </TaxRate>
        <TaxRate>
          <Type>NZ_GST_Overseas_Supplies</Type>
          <Country>ABC</Country>
          <Name>ABC</Name>
          <FlatRate>123.0</FlatRate>
          <Description>ABC</Description>
          <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
          <IsTaxEffective>false</IsTaxEffective>
        </TaxRate>
      </TaxesIncluded>
      <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>
      <ShippingOptions>
        <ShippingOption>
          <Type>None</Type>
          <Price>123.0</Price>
          <Method>ABC</Method>
          <ShippingId>123</ShippingId>
          <TaxesIncluded>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
          </TaxesIncluded>
        </ShippingOption>
        <ShippingOption>
          <Type>None</Type>
          <Price>123.0</Price>
          <Method>ABC</Method>
          <ShippingId>123</ShippingId>
          <TaxesIncluded>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
            <TaxRateOnPrice>
              <Type>NZ_GST_Overseas_Supplies</Type>
              <Country>ABC</Country>
              <Name>ABC</Name>
              <FlatRate>123.0</FlatRate>
              <Description>ABC</Description>
              <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
              <IsTaxEffective>false</IsTaxEffective>
              <IsApplied>false</IsApplied>
              <TaxAmount>123.0</TaxAmount>
              <WasPriceTaxAmount>123.0</WasPriceTaxAmount>
            </TaxRateOnPrice>
          </TaxesIncluded>
        </ShippingOption>
      </ShippingOptions>
      <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,
      "TaxesIncluded": [
        {
          "Type": 1,
          "Country": "ABC",
          "Name": "ABC",
          "FlatRate": 123.0,
          "Description": "ABC",
          "IsSellRestrictionsEffective": false,
          "IsTaxEffective": false
        },
        {
          "Type": 1,
          "Country": "ABC",
          "Name": "ABC",
          "FlatRate": 123.0,
          "Description": "ABC",
          "IsSellRestrictionsEffective": false,
          "IsTaxEffective": false
        }
      ],
      "ListingId": 123,
      "Title": "ABC",
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "BidCount": 123,
      "Mcat": "ABC",
      "ShippingOptions": [
        {
          "Type": 0,
          "Price": 123.0,
          "Method": "ABC",
          "ShippingId": 123,
          "TaxesIncluded": [
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            },
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            }
          ]
        },
        {
          "Type": 0,
          "Price": 123.0,
          "Method": "ABC",
          "ShippingId": 123,
          "TaxesIncluded": [
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            },
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            }
          ]
        }
      ],
      "PictureHref": "ABC"
    },
    {
      "OfferPrice": 123.0,
      "OfferExpiryDate": "\/Date(1514764800)\/",
      "Quantity": 123,
      "TaxesIncluded": [
        {
          "Type": 1,
          "Country": "ABC",
          "Name": "ABC",
          "FlatRate": 123.0,
          "Description": "ABC",
          "IsSellRestrictionsEffective": false,
          "IsTaxEffective": false
        },
        {
          "Type": 1,
          "Country": "ABC",
          "Name": "ABC",
          "FlatRate": 123.0,
          "Description": "ABC",
          "IsSellRestrictionsEffective": false,
          "IsTaxEffective": false
        }
      ],
      "ListingId": 123,
      "Title": "ABC",
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "BidCount": 123,
      "Mcat": "ABC",
      "ShippingOptions": [
        {
          "Type": 0,
          "Price": 123.0,
          "Method": "ABC",
          "ShippingId": 123,
          "TaxesIncluded": [
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            },
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            }
          ]
        },
        {
          "Type": 0,
          "Price": 123.0,
          "Method": "ABC",
          "ShippingId": 123,
          "TaxesIncluded": [
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            },
            {
              "Type": 1,
              "Country": "ABC",
              "Name": "ABC",
              "FlatRate": 123.0,
              "Description": "ABC",
              "IsSellRestrictionsEffective": false,
              "IsTaxEffective": false,
              "IsApplied": false,
              "TaxAmount": 123.0,
              "WasPriceTaxAmount": 123.0
            }
          ]
        }
      ],
      "PictureHref": "ABC"
    }
  ]
}