Skip to content

Returns the list of store chains.

GET
/api/chains

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Parameters

Query Parameters

pageSize*

Count of chains on page

Typestring
Required
Default0
Pattern"\\d+"
offset*

Offset of items

Typestring
Required
Default0
Pattern"\\d+"

Responses

Success.

application/json
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": 0,
"name": "string",
"avatar": "string",
"isSleeping": true
}
],
"estimatedStoreCount": 12,
"modificationDate": "string",
"regionId": 0
},
"storeCount": 5
}
]

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python