Categories and figures

GET/v1/categories/{id}/stop-stocking

The products worth no longer stocking, most money tied up first.

What it does

A product a person marked Never stop stocking is not on the list. ?format=csv answers the whole list with the columns of the app's download; that needs the export ability and is written to the audit log.

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. Some uses also need export (take the figures out as a spreadsheet): the description above says which.

Request

HTTP

GET https://panlytics.net/api/v1/categories/{id}/stop-stocking

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.
`format`	query	string: json, csv	No	`csv` answers the whole list as one CSV file, with the columns the app's own download has. Paging is ignored then.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

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

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/stop-stocking",
    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/stop-stocking", {
  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.

With ?format=csv the answer is text/csv instead: the whole list as one file, with the columns of the app's own download. That needs the export ability, and it is written to the audit log.

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[].salesEur`	number	Yes	Sales over the report's period, in euros.
`data[].marginEur`	number	Yes	Profit on the sales over the report's period, in euros.
`data[].wasteEur`	number	Yes	What was thrown away over the report's period, in euros.
`data[].stockEur`	number	Yes	The money tied up in its stock now.
`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": "6410000000093",
      "name": "Tonic water 1 l",
      "salesEur": 12.4,
      "marginEur": 3.1,
      "wasteEur": 8.9,
      "stockEur": 41.6
    }
  ],
  "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.
403	`refused.demo`	The key belongs to a shared demo account, which may not change anything.	Use a key made in a real company account.
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.