The sheet and exceptions
POST/v1/shops/{id}/exception-imports
Write many exceptions at once from a .csv or .xlsx file.
What it does
Four columns, in this order: the product's barcode, the level to keep it at, whether it must never be stopped, and why. A header row is skipped. All or nothing: a row the file gets wrong refuses the whole file, and nothing is written.
Who may call it
A key whose maker's role holds exceptions (manage exceptions), after the fence, for the shop or category it names.
Request
HTTP
POST https://panlytics.net/api/v1/shops/{id}/exception-importsParameters
| 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. |
Body
Sent as multipart/form-data.
| Field | Type | Required | What it is |
|---|---|---|---|
file | file | Yes | The file, as .csv or .xlsx. |
Example request
curl -X POST https://panlytics.net/api/v1/shops/12/exception-imports \
-H "Authorization: Bearer $PANLYTICS_KEY" \
-F "file=@sales-report.csv"import os
import requests
with open("sales-report.csv", "rb") as report:
response = requests.post(
"https://panlytics.net/api/v1/shops/12/exception-imports",
headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
files={"file": ("sales-report.csv", report)},
data={},
timeout=60,
)
response.raise_for_status()
print(response.json())import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("file", new Blob([await readFile("sales-report.csv")]), "sales-report.csv");
const response = await fetch("https://panlytics.net/api/v1/shops/12/exception-imports", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
},
body: form,
});
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 |
|---|---|---|---|
imported | integer | Yes | How many rules the file wrote. |
Example response
200
{
"imported": 40
}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. |
| 413 | upload.too_large | That file is too big to upload. | Send a file under instead. |
| 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. |