Returns the list of store chains.
Returns the list of store chains.
Query Parameters
- pageSize string required
Possible values: Value must match regular expression
\d+
Count of chains on page
- offset string required
Possible values: Value must match regular expression
\d+
Offset of items
- 200
- 401
- 403
Success.
- application/json
- Schema
- Example (from schema)
Schema array
chain object
id Unique identifier of the chain.name Name of the chain.Possible values:
<= 120 characters
Field does not support HTML, Markdown or multiline strings.
status objectPossible values:
<= 2
, [0
,1
,2
]headquartersZip ZIP code of the chains headquater.Possible values:
<= 120 characters
headquartersCity City of the chains headquater.Possible values:
<= 50 characters
Field does not support HTML, Markdown or multiline strings.
headquartersCountry Country of the chains headquater.Possible values:
<= 50 characters
Field does not support HTML, Markdown or multiline strings.
allowPress Whether the chain can be referred to in press releases.forumThread Identifier of a forum thread related to this chain.Only visible to members of AG store chain
notes Miscellaneous notes.Possible values:
<= 200 characters
Field does not support HTML, Markdown or multiline strings.
commonStoreInformation Information about the chain to be displayed on every related stores page.Possible values:
<= 16777215 characters
kams object[]
id Unique identifier of the foodsaver.name Name of the Foodsaver.Might include the last name.
avatar URL of the foodsavers avatar image.estimatedStoreCount Count of estimated stores.Only visible to members of AG store chain
modificationDate date-timeregionId Region of store chain management.- storeCount The number of stores that are part of this chain.
[
{
"chain": {
"id": 1,
"name": "MyChain GmbH",
"status": {},
"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": "2023-09-30",
"regionId": 0
},
"storeCount": 5
}
]
Not logged in
Insufficient permissions