Shops
GET/v1/shops/{id}/categories
The categories of one shop, each with its newest report.
What it does
A key whose maker is limited to chosen categories sees only those.
Who may call it
A key whose maker's role holds figures (see the figures), after the fence, for the shop or category it names.
Request
HTTP
GET https://panlytics.net/api/v1/shops/{id}/categoriesParameters
| Name | In | Type | Required | What it is |
|---|---|---|---|---|
id | path | integer | Yes | The shop's id. |
cursor | query | string | No | The nextCursor of the page before. Leave it out for the first page. Treat it as an opaque string. |
limit | query | integer | No | How many rows on one page: 1 to 200, 50 when left out. |
Authorization | header | string | Yes | Bearer, a space, then the key. |
Example request
curl https://panlytics.net/api/v1/shops/12/categories \
-H "Authorization: Bearer $PANLYTICS_KEY"import os
import requests
response = requests.get(
"https://panlytics.net/api/v1/shops/12/categories",
headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
timeout=60,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://panlytics.net/api/v1/shops/12/categories", {
headers: {
Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
},
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());Response
200: The answer, as JSON.
| Field | Type | Always there | What it is |
|---|---|---|---|
data[] | object[] | Yes | The rows of this page. |
data[].id | integer | Yes | The category's id. |
data[].shopId | integer | Yes | The shop the category belongs to. |
data[].name | string | Yes | The category's name, as people in the company say it. |
data[].reportId | integer | Yes | The newest report of this category. Its figures are the ones every endpoint answers with. |
data[].products | integer | Yes | How many products the newest report holds. |
data[].uploadedAt | string (ISO 8601) | Yes | When the newest report was uploaded, in UTC. |
data[].updatedAt | string (ISO 8601) | Yes | When the newest report or its settings last changed. Send it back as updatedAt on PATCH. |
nextCursor | string or null | Yes | Send it as cursor for the next page. Null on the last page. |
total | integer | Yes | How many rows the whole list has. |
Example response
200
{
"data": [
{
"id": 40,
"shopId": 12,
"name": "Beverages",
"reportId": 311,
"products": 412,
"uploadedAt": "2026-10-20T07:12:00.000Z",
"updatedAt": "2026-10-20T07:12:00.000Z"
}
],
"nextCursor": null,
"total": 1
}Errors
A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.
| Status | Code | When | What to do |
|---|---|---|---|
| 400 | api.invalid | A path id, a query parameter, a header or a body field is missing or not valid. detail names the field. | Read that endpoint in the API reference, correct the field and call again. |
| 401 | api.key_missing | The call had no Authorization header. | Send the key in the Authorization header as Bearer, then call again. |
| 401 | api.key_refused | The key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability). | Ask the person who gave you the key to make a new one. |
| 401 | api.wrong_key_kind | This key does not open these endpoints. | Use the key these endpoints were made for, or ask the person who gave you the key. |
| 403 | refused | The key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach. | Ask the CEO for a role that allows it, or call it for a shop or category the role reaches. |
| 403 | auth.not_fresh | This step needs you to prove it is you. | Confirm your password or passkey, then try again. |
| 404 | not_found.said | Nothing with that id in the key's company. An id of another company answers the same. | Check the id. List the shop or category it belongs to and take the id from there. |
| 429 | api.rate_limited | The key made more than 120 calls in this minute. Wait the seconds in Retry-After. | Wait the seconds in Retry-After, then call again. |
| 500 | server | Something failed on our side. The answer carries a requestId to quote. | Try again in a minute; if it keeps happening, report it. |
| 503 | developer.unavailable | API keys are not set up on this deployment yet. | Report it, and we will switch them on. |