Skip to content

Returns the list of store chains.

GET
/api/chains

Authorizations

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

Parameters

Query Parameters

pageSize*

Count of chains on page

Typestring
Required
offset*

Offset of items

Typestring
Required

Responses

Success.
JSON
[
{
"chain": {
"id": 1,
"name": "MyChain GmbH",
"status": 2,
"headquartersZip": "48149",
"headquartersCity": "Münster",
"headquartersCountry": "Germany",
"allowPress": true,
"forumThread": 12345,
"notes": "Cooperating since 2021",
"commonStoreInformation": "Pickup times between 10:00 and 12:15",
"kams": [
{
"id": 1,
"name": "Max Mustermann",
"avatar": "/api/uploads/bc476952-08be-45a7-b670-db27c966c9c2"
}
],
"estimatedStoreCount": 12,
"modificationDate": "string",
"regionId": 0
},
"storeCount": 5
}
]
Authorization
api_key
Variables
Key
Value
pageSize*
offset*
cURL
curl -X GET \
'http://localhost/api/chains'

Samples

cURL
curl -X GET http://localhost/api/chains
JavaScript
fetch("http://localhost/api/chains")
  .then(response => response.json())
  .then(data => console.log(data));
PHP
file_get_contents("http://localhost/api/chains");
Python
import requests
response = requests.get("http://localhost/api/chains")
print(response.json())