Stock decisions

POST/v1/shops/{id}/overstock-decisions

Record what to do about an overstocked product: transfer, return, write off or discount.

What it does

Needs the sheet ability over the whole shop, as in the app. The decision is recorded and written to the audit log; it moves no stock by itself. Send an Idempotency-Key header so a retry never records it twice.

Who may call it

A key whose maker's role holds sheet (edit the sheet and upload a report), after the fence, for the shop or category it names.

Request

HTTP

POST https://panlytics.net/api/v1/shops/{id}/overstock-decisions

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The shop's id.
`Authorization`	header	string	Yes	Bearer, a space, then the key.
`Idempotency-Key`	header	string	No	Any string up to 255 characters, new for each new request. The same key with the same request within 24 hours answers with the first answer again and does nothing twice.

Body

Sent as application/json.

Field	Type	Required	What it is
`productId`	string	Yes	The product the decision is about, usually its barcode (EAN).
`action`	string: transfer, return, writeOff, discount	Yes	transfer, return, writeOff or discount.
`reason`	string	No	Why, in a sentence.

Example request

curl -X POST https://panlytics.net/api/v1/shops/12/overstock-decisions \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": "6410000000017",
  "action": "discount",
  "reason": "Best before in a week."
}'

import os
import uuid

import requests

response = requests.post(
    "https://panlytics.net/api/v1/shops/12/overstock-decisions",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
      "productId": "6410000000017",
      "action": "discount",
      "reason": "Best before in a week."
    },
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/shops/12/overstock-decisions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "productId": "6410000000017",
    "action": "discount",
    "reason": "Best before in a week."
  }),
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());

Response

201: Created. The answer is what was made, as JSON.

Field	Type	Always there	What it is
`id`	integer	Yes	The id of the decision just recorded.

Example response

201

{
  "id": 3
}

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.
400	`bad_request.said`		Change it and try 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	`api.idempotency_conflict`	That Idempotency-Key was sent before with a different request.	Send a new key with a new request, or send the first request again unchanged.
409	`api.idempotency_busy`	The first request with that Idempotency-Key is still running.	Wait a few seconds, then send it again.
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.