Website logo

Store search

Performs a search within the list of registered stores.

URL: https://api.trademe.co.nz/v1/Search/Stores.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
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

category String (optional)

The ID of a category. Filters the list of stores to those that have at least one active listing in the category.
page Integer (optional)

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

The maximum number of results to return. Defaults to 50.
search_string String (optional)

One or more search keywords.

Returns

<Stores>

A list of stores that match the search criteria.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <Store> or null InnerList
Name String or null Name
MemberId Integer MemberId
LogoImageUri String or null LogoImageUri
ListingCount Integer ListingCount
ShortDescription String or null ShortDescription
LargeBannerImage <LargeBannerImage> or null LargeBannerImage
Small String or null Small
Medium String or null Medium
Large String or null Large
XLarge String or null XLarge
StorePath String or null StorePath
SaleCount Integer SaleCount
MemberProfile <SimpleMemberProfile> or null MemberProfile
Occupation String or null Occupation
Biography String or null Biography
Quote String or null Quote
Photo String or null Photo
Nickname String or null Nickname
Member <Member> or null Member
MemberId Integer MemberId
Nickname String or null Nickname
DateAddressVerified DateTime DateAddressVerified
DateJoined DateTime DateJoined
UniqueNegative Integer UniqueNegative
UniquePositive Integer UniquePositive
FeedbackCount Integer FeedbackCount
IsAddressVerified Boolean IsAddressVerified
IsDealer Boolean IsDealer
IsAuthenticated Boolean IsAuthenticated
IsInTrade Boolean IsInTrade
IsRentiUser Boolean IsRentiUser
FavouriteId Integer or null FavouriteId
Tier Enumeration Tier
NotAStore 0 NotAStore
Basic 1 Basic
Premium 2 Premium

Example XML Response (switch to JSON) 

<Stores xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <Store>
      <Name>ABC</Name>
      <MemberId>123</MemberId>
      <LogoImageUri>ABC</LogoImageUri>
      <ListingCount>123</ListingCount>
      <ShortDescription>ABC</ShortDescription>
      <LargeBannerImage>
        <Small>ABC</Small>
        <Medium>ABC</Medium>
        <Large>ABC</Large>
        <XLarge>ABC</XLarge>
      </LargeBannerImage>
      <StorePath>ABC</StorePath>
      <SaleCount>123</SaleCount>
      <MemberProfile>
        <Occupation>ABC</Occupation>
        <Biography>ABC</Biography>
        <Quote>ABC</Quote>
        <Photo>ABC</Photo>
        <Nickname>ABC</Nickname>
      </MemberProfile>
      <Member>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
        <IsInTrade>false</IsInTrade>
        <IsRentiUser>false</IsRentiUser>
      </Member>
      <FavouriteId>123</FavouriteId>
      <Tier>NotAStore</Tier>
    </Store>
    <Store>
      <Name>ABC</Name>
      <MemberId>123</MemberId>
      <LogoImageUri>ABC</LogoImageUri>
      <ListingCount>123</ListingCount>
      <ShortDescription>ABC</ShortDescription>
      <LargeBannerImage>
        <Small>ABC</Small>
        <Medium>ABC</Medium>
        <Large>ABC</Large>
        <XLarge>ABC</XLarge>
      </LargeBannerImage>
      <StorePath>ABC</StorePath>
      <SaleCount>123</SaleCount>
      <MemberProfile>
        <Occupation>ABC</Occupation>
        <Biography>ABC</Biography>
        <Quote>ABC</Quote>
        <Photo>ABC</Photo>
        <Nickname>ABC</Nickname>
      </MemberProfile>
      <Member>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
        <IsInTrade>false</IsInTrade>
        <IsRentiUser>false</IsRentiUser>
      </Member>
      <FavouriteId>123</FavouriteId>
      <Tier>NotAStore</Tier>
    </Store>
  </List>
</Stores>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "Name": "ABC",
      "MemberId": 123,
      "LogoImageUri": "ABC",
      "ListingCount": 123,
      "ShortDescription": "ABC",
      "LargeBannerImage": {
        "Small": "ABC",
        "Medium": "ABC",
        "Large": "ABC",
        "XLarge": "ABC"
      },
      "StorePath": "ABC",
      "SaleCount": 123,
      "MemberProfile": {
        "Occupation": "ABC",
        "Biography": "ABC",
        "Quote": "ABC",
        "Photo": "ABC",
        "Nickname": "ABC"
      },
      "Member": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false,
        "IsInTrade": false,
        "IsRentiUser": false
      },
      "FavouriteId": 123,
      "Tier": 0
    },
    {
      "Name": "ABC",
      "MemberId": 123,
      "LogoImageUri": "ABC",
      "ListingCount": 123,
      "ShortDescription": "ABC",
      "LargeBannerImage": {
        "Small": "ABC",
        "Medium": "ABC",
        "Large": "ABC",
        "XLarge": "ABC"
      },
      "StorePath": "ABC",
      "SaleCount": 123,
      "MemberProfile": {
        "Occupation": "ABC",
        "Biography": "ABC",
        "Quote": "ABC",
        "Photo": "ABC",
        "Nickname": "ABC"
      },
      "Member": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false,
        "IsInTrade": false,
        "IsRentiUser": false
      },
      "FavouriteId": 123,
      "Tier": 0
    }
  ]
}