SpyREST - Beautiful auto generated REST API documentation

GET /v2/stores

Description

Query Parameters

Name	Type	Example Values
`app_key`	String	8b3a2ce815b9a42cc05767ad58728232
`app_id`	String	eb2c3bd1
`q`	String	a

Response Fields

Name	Type	Description
message	String
result.stores	Array
result.stores[].id	Integer
result.stores[].name	String
result.stores[].countryCode	String

Write

Preview

Examples

Searches for a list of stores

Recorded at

2015-11-23 04:46:45 UTC

Try with cURL

Request URL

GET /v2/stores?q=a&app_id=eb2c3bd1&app_key=8b3a2ce815b9a42cc05767ad58728232

Query Parameters

app_key: 8b3a2ce815b9a42cc05767ad58728232
app_id: eb2c3bd1
q: a

Request Headers

accept: application/json
user-agent: curl/7.37.1

Response Headers

transfer-encoding: chunked
connection: close
content-length: 2867
x-3scale-proxy-secret-token: Shared_secret_sent_from_proxy_to_API_backend
vary: Accept-Encoding
server: nginx
date: Mon, 23 Nov 2015 04:46:45 GMT
content-type: application/json

Response Body

Shortened for readability

{
  "message": "ok",
  "result": {
    "stores": [
      {
        "id": 575,
        "name": "Ten Thousand Villages",
        "countryCode": "US"
      },
      {
        "id": 204,
        "name": "Toys Camp",
        "countryCode": "US"
      }
    ]
  }
}