Categories and figures

GET/v1/categories/{id}/products/{ean}

One product in full: what it sold, what it missed, its reorder point and why, and what to order.

What it does

Everything the app shows when a product's row is opened, from the category's newest report.

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/{ean}

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The category's id.
`ean`	path	string	Yes	The product's id in the shop's own system, usually its barcode (EAN).
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

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

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/categories/40/products/6410000000017",
    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/6410000000017", {
  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
`ean`	string	Yes	The product's id, usually its barcode (EAN).
`name`	string	Yes	The product's name.
`class`	string	Yes	The sales class, A to D.
`periodDays`	integer	Yes	How many days the report covers.
`onShelfDays`	integer	Yes	Days the product was on the shelf.
`outOfStockDays`	integer	Yes	Days the shelf was empty.
`soldPcs`	integer	Yes	Pieces sold over the period.
`perDay`	number	Yes	Pieces sold on an average day.
`salesEur`	number	Yes	Sales over the period, in euros.
`marginEur`	number	Yes	Profit on those sales, in euros.
`marginPct`	number	Yes	Profit as a share of sales, in percent.
`lostSalesEur`	number	Yes	Sales missed while the shelf was empty, in euros.
`stockPcs`	integer	Yes	Pieces held now, across the shop's locations.
`stockEur`	number	Yes	The money tied up in that stock, in euros.
`reorderPointNow`	integer	Yes	The reorder point the report gave.
`newReorderPoint`	integer	Yes	The reorder point Panlytics works out.
`waitPcs`	integer	Yes	The part of the new reorder point that sells while a delivery is on its way.
`safetyPcs`	integer	Yes	The rest of the new reorder point: the safety buffer.
`orderPcs`	integer	Yes	How much to order when the level is reached, in whole pieces.
`packSize`	integer	Yes	How many pieces come in one pack.
`packSizeKnown`	boolean	Yes	False when the report's pack size column held one repeated value, so the pack size is a guess.
`orderValueEur`	number	Yes	What that order costs, in euros.
`purchasePrice`	number	Yes	What one piece costs to buy, in euros.
`salesPrice`	number	Yes	What one piece sells for, in euros.
`wastePcs`	integer	Yes	Pieces thrown away over the period.
`wasteEur`	number	Yes	Thrown away over the period, in euros.
`rank`	integer	Yes	Where the product ranks by sales in its category, 1 being the best seller.
`of`	integer	Yes	How many products the category holds.
`lowConfidence`	boolean	Yes	True when the product sold too little for its figures to be sure.

Example response

200

{
  "ean": "6410000000017",
  "name": "Sparkling water 0.5 l",
  "class": "A",
  "periodDays": 30,
  "onShelfDays": 27,
  "outOfStockDays": 3,
  "soldPcs": 1210,
  "perDay": 40.3,
  "salesEur": 1840.5,
  "marginEur": 610.2,
  "marginPct": 33.15,
  "lostSalesEur": 182.1,
  "stockPcs": 9,
  "stockEur": 4.5,
  "reorderPointNow": 12,
  "newReorderPoint": 18,
  "waitPcs": 12,
  "safetyPcs": 6,
  "orderPcs": 24,
  "packSize": 24,
  "packSizeKnown": true,
  "orderValueEur": 12,
  "purchasePrice": 0.5,
  "salesPrice": 1.52,
  "wastePcs": 0,
  "wasteEur": 0,
  "rank": 1,
  "of": 412,
  "lowConfidence": false
}

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.