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

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

A list of the results in the current page.

Name String or null

The name of the store.

MemberId Integer

The ID of the member which corresponds to this store.

LogoImageUri String or null

The URL of a small logo image (180x52).

ListingCount Integer

The number of live listings. Only returned when browsing the stores list.

ShortDescription String or null

A short description of what the store sells. Only returned when browsing the stores list.

LargeBannerImage <LargeBannerImage> or null

The URL's of a large banner image for each breakpoint, small, medium, large, extra large. When requesting listing details, only stores extra listings have a large banner image.

Small String or null

The URL of the promotional image in small size 320x180

Medium String or null

The URL of the promotional image in medium size 768x432.

Large String or null

The URL of the promotional image in large size 1024x576.

XLarge String or null

The URL of the promotional image in extra large size 1440x810.

StorePath String or null

A url friendly path for the store, that is unique.

SaleCount Integer

The number of on sale listings

MemberProfile <SimpleMemberProfile> or null

The member profile details associated with this store

Occupation String or null

The occupation of the member.

Biography String or null

The member's bio.

Quote String or null

The member's favourite quote.

Photo String or null

A URL representing the member's photo.

Nickname String or null

The member's nickname

Member <Member> or null

The member details associated with this store

MemberId Integer

The ID of the member. This may be 0, if we determine it is necessary to protect the member's privacy.

Nickname String or null

The nickname of the member. Some characters may be changed, if we determine it is necessary to protect the member's privacy.

DateAddressVerified DateTime

The date the member was address verified.

DateJoined DateTime

The date the member joined.

UniqueNegative Integer

The number of distinct members who have placed negative feedback against this member.

UniquePositive Integer

The number of distinct members who have placed positive feedback against this member.

FeedbackCount Integer

The member's total feedback (UniquePositive minus UniqueNegative).

IsAddressVerified Boolean

Indicates whether the member has been address verified.

IsDealer Boolean

Indicates whether the member is a car dealer.

IsAuthenticated Boolean

Indicates whether the member is authenticated.

IsInTrade Boolean

Indicates whether the member is a professional trader.

FavouriteId Integer or null

The ID of a favourite seller, if the call is authenticated and the authenticated member has added this store to their favourites. Currently only supported when retrieving promoted stores.

Tier Enumeration

The tier ID of a tiered store

NotAStore 0

Store tier not applicable

Basic 1

Basic tier

Premium 2

Premium tier

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>
      </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>
      </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
      },
      "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
      },
      "FavouriteId": 123,
      "Tier": 0
    }
  ]
}