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 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
TaxesIncluded Collection of <TaxRate> or null TaxesIncluded
Type Enumeration Type
NZ_GST_Overseas_Supplies 1 NZ_GST_Overseas_Supplies
Country String or null Country
Name String or null Name
FlatRate Number FlatRate
Description String or null Description
IsSellRestrictionsEffective Boolean IsSellRestrictionsEffective
IsTaxEffective Boolean IsTaxEffective
ListingId Integer ListingId
Title String or null Title
StartDate DateTime StartDate
EndDate DateTime EndDate
BidCount Integer BidCount
Mcat String or null Mcat
ShippingOptions Collection of <ShippingOption> or null ShippingOptions
Type Enumeration ShippingType
None 0 None
Unknown 0 Unknown
Undecided 1 Undecided
Pickup 2 Pickup
Free 3 Free
Custom 4 Custom
TradeMe 5 TradeMe
Price Number Price
Method String or null Method
ShippingId Integer ShippingId
TaxesIncluded Collection of <TaxRateOnPrice> or null TaxesIncluded
Type Enumeration Type
NZ_GST_Overseas_Supplies 1 NZ_GST_Overseas_Supplies
Country String or null Country
Name String or null Name
FlatRate Number FlatRate
Description String or null Description
IsSellRestrictionsEffective Boolean IsSellRestrictionsEffective
IsTaxEffective Boolean IsTaxEffective
IsApplied Boolean IsApplied
TaxAmount Number or null TaxAmount
WasPriceTaxAmount Number or null WasPriceTaxAmount
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>
      <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"
    }
  ]
}