Appearance

Get the stores of a region​

GET
/api/regions/{regionId}/stores

Authorizations​

api_key

Requests manipulating data need to supply a CSRF token

Type
API Key (header: X-CSRF-Token)

Parameters​

Path Parameters

regionId*
Type
integer
Required
Minimum
1

Query Parameters

offset

Index of the first store to return (for pagination).

Type
[ "integer", "null" ]
Default
0
Minimum
0
limit

Maximum number of stores to return (for pagination). Capped at 1000.

Type
[ "integer", "null" ]
Default
100
Maximum
1000
Minimum
1

Responses​

Success

application/json
JSON
[
  
{
  
  
"id": 0,
  
  
"name": "string",
  
  
"region": {
  
  
  
"id": 0,
  
  
  
"name": null
  
  
},
  
  
"location": {
  
  
  
"lat": 52.5,
  
  
  
"lon": 13.4
  
  
},
  
  
"street": "string",
  
  
"city": "string",
  
  
"zipCode": "string",
  
  
"cooperationStatus": 0,
  
  
"createdAt": "string",
  
  
"categoryType": 0
  
}
]

Playground​

Authorization
Variables
Key
Value

Samples​