Suppliers

PATCH/v1/suppliers/{id}

Rename a supplier or change the days a delivery takes from it.

What it does

Send only what changes. The figures of the categories it delivers change at once.

Who may call it

A key whose maker's role holds suppliers (manage suppliers), after the fence, for the shop or category it names.

Request

HTTP

PATCH https://panlytics.net/api/v1/suppliers/{id}

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The supplier's id.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Body

Sent as application/json.

Field	Type	Required	What it is
`name`	string	No	The supplier's name, unique in the shop.
`leadTimeDays`	integer	No	The days a delivery takes, 0 to 365.

Example request

curl -X PATCH https://panlytics.net/api/v1/suppliers/5 \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "leadTimeDays": 3
}'

import os

import requests

response = requests.patch(
    "https://panlytics.net/api/v1/suppliers/5",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    json={
      "leadTimeDays": 3
    },
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/suppliers/5", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "leadTimeDays": 3
  }),
});
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
`id`	integer	Yes	The supplier's id.
`shopId`	integer	Yes	The shop the supplier delivers to.
`name`	string	Yes	The supplier's name.
`leadTimeDays`	integer	Yes	The days a delivery takes from this supplier.
`categoryIds[]`	integer[]	Yes	The categories this supplier delivers.
`createdAt`	string (ISO 8601)	Yes	When the supplier was added, in UTC.
`updatedAt`	string (ISO 8601)	Yes	When the supplier last changed, in UTC.

Example response

200

{
  "id": 5,
  "shopId": 12,
  "name": "Example Wholesale",
  "leadTimeDays": 3,
  "categoryIds": [
    40
  ],
  "createdAt": "2026-10-01T08:00:00.000Z",
  "updatedAt": "2026-10-25T09:00:00.000Z"
}

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	`conflict.said`	The shop already has a supplier with that name.	Use another name, or change the supplier that has it.
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.