Categories and figures

GET/v1/categories/{id}/products

Every product of a category with what it holds, sells and triggers at, as the Products page lists them.

What it does

From the category's newest report, by name. q finds products by name or id. A category of more than 3,000 products lists its 3,000 best sellers, as the app does.

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/categories/{id}/products

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The category'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.
`q`	query	string	No	Only the products whose name (in any case) or id contains this. Leave it out for all of them.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

curl https://panlytics.net/api/v1/categories/40/products \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/products",
    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/categories/40/products", {
  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[].ean`	string	Yes	The product's id in the shop's own system, usually its barcode (EAN).
`data[].name`	string	Yes	The product's name.
`data[].stockPcs`	number	Yes	Pieces on the shelf on the report day.
`data[].reorderPoint`	number or null	Yes	The reorder point the shop's own system holds, or null when none is set.
`data[].newReorderPoint`	number	Yes	The reorder point Panlytics works with: a level a person fixed, or the one worked out. 0 for a product on the stop-stocking list.
`data[].keptByHand`	boolean	Yes	True when a person fixed the level as an exception.
`data[].stopStocking`	boolean	Yes	True when the product is on the stop-stocking list.
`data[].soldPcs`	number	Yes	Pieces sold over the report's period.
`data[].salesEur`	number	Yes	What those pieces brought in, in euros, VAT 0%.
`data[].buyPrice`	number	Yes	What one piece costs to buy, in euros, VAT 0%.
`data[].sellPrice`	number	Yes	What one piece sells for, in euros, VAT 0%.
`data[].unitProfit`	number	Yes	What is kept on one piece, in euros. Negative when it sells below what it cost.
`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": [
    {
      "ean": "6410000000017",
      "name": "Sparkling water 0.5 l",
      "stockPcs": 9,
      "reorderPoint": 12,
      "newReorderPoint": 18,
      "keptByHand": false,
      "stopStocking": false,
      "soldPcs": 1210,
      "salesEur": 1840.5,
      "buyPrice": 0.5,
      "sellPrice": 1.52,
      "unitProfit": 1.02
    }
  ],
  "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.
409	`report.none`	There is no report yet to work from.	Upload a report first, with POST /v1/shops/{id}/reports.
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.