Search Stores

Returns a collection of storeKey values based on the search parameters.

Searches for stores based on passed parameters. Doesn't allow you to interact with the stores returned, just gives keys which can be used to give a little more information about the stores. This could be useful for a Geo Location application.

{
    "totalItems": integer,
    "success": boolean,
    "errors": [],
    "results": [
        string,
      	string,
      	string
    ]
}
/stores?name=Gamer

{
    "totalItems": 479,
    "success": true,
    "errors": [],
    "results": [
        "369cc67b",
        "7b19d7b9",
        "a4a75f58",
        "6681c773",
        "9522e0a4",
        "f17ab081",
        "b4f24b1a",
        "11401f01",
        "986f6f26",
        "3a5dd391"
    ]
}
Query Params
string

Optional filter to search by store name.

string

Optional filter to search by store address.

string

Optional filter to search by store city.

string

Optional filter to search by store state.

string

Optional filter to search by store ZIP/Postal code.

string

If specified, sort the results by this value. Default is "Name ASC".

int32

Used for paging. The number of records to skip. Default is 0.

int32

Used for paging. The maximum number of records to return. Default is 10.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json