Reports

POST/v1/shops/{id}/reports

Upload a report: the first of a new category, or the next report of one.

What it does

Multipart form data with a file (.csv or .xlsx, at most 8 MB) and either category, the name of a new category, with periodDays, or categoryId for the next report of a category. The file goes through exactly the checks and the pipeline the app's own upload does, and the upload is written to the audit log. Demo accounts cannot upload. Send an Idempotency-Key header so a retry never files the report 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}/reports

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 multipart/form-data.

Field	Type	Required	What it is
`file`	file	Yes	The report, as .csv or .xlsx.
`category`	string	No	The name of a NEW category this report starts.
`categoryId`	integer	No	The category this report is the next report of.
`periodDays`	integer	No	How many days the report covers. Needed for a new category; a next report keeps its category's period when left out.

Example request

curl -X POST https://panlytics.net/api/v1/shops/12/reports \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@sales-report.csv" \
  -F "category=Beverages" \
  -F "periodDays=30"

import os
import uuid

import requests

with open("sales-report.csv", "rb") as report:
    response = requests.post(
        "https://panlytics.net/api/v1/shops/12/reports",
        headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
        files={"file": ("sales-report.csv", report)},
        data={"category": "Beverages", "periodDays": "30"},
        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");
form.append("category", "Beverages");
form.append("periodDays", "30");

const response = await fetch("https://panlytics.net/api/v1/shops/12/reports", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: form,
});
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
`reportId`	integer	Yes	The new report's id.
`categoryId`	integer or null	Yes	The category the report was filed under.
`shopId`	integer	Yes	The shop the report belongs to.
`newCategory`	boolean	Yes	True when this report started a new category.
`rows`	integer	Yes	How many product rows were read from the file.
`deduplicated`	boolean	Yes	True when this exact file was uploaded before. It was worked out again and stored once.

Example response

201

{
  "reportId": 311,
  "categoryId": 40,
  "shopId": 12,
  "newCategory": true,
  "rows": 412,
  "deduplicated": 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.
400	`upload.said`	The file failed a check: its type, its size, or what it holds. `detail` says which.	Fix the file, then upload it 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.
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.
413	`upload.too_large`	That file is too big to upload.	Send a file under instead.
422	`form.field`	A field of the upload was refused. `detail` says which and why.	Fix that field, then upload again.
422	`upload.unreadable`	That file could not be read.	Check it opens on your machine, then upload 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.