# POST /v1/shops/{id}/basket-scans

> Ask the AI to propose product groups: products bought together, which keep each other in stock.

Markdown twin of https://panlytics.net/developers/api/baskets-scan (last updated 2026-10-25). Every page of the Panlytics developer docs is listed at https://panlytics.net/developers/llms.txt, and all of them are in one file at https://panlytics.net/developers/llms-full.txt. The site guide is https://panlytics.net/llms.txt.

## What it does

The Baskets page's scan, the same AI pass over every product of every category. Needs the sheet ability over the whole shop. It replaces the shop's proposals and keeps every decision a person already made on a group that is proposed again. What it finds are proposals: a group changes the figures only once a person approves it in the app. It spends AI and can take a minute or more, and is written to the audit log. A key's maker may run area research and basket scans 20 times a day in all (429 after that). Read the result with GET /v1/shops/{id}/baskets.

## 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}/basket-scans
```

### 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. |

### Example request

```bash title="curl"
curl -X POST https://panlytics.net/api/v1/shops/12/basket-scans \
  -H "Authorization: Bearer $PANLYTICS_KEY"
```
```python title="Python"
import os

import requests

response = requests.post(
    "https://panlytics.net/api/v1/shops/12/basket-scans",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())
```
```typescript title="TypeScript"
const response = await fetch("https://panlytics.net/api/v1/shops/12/basket-scans", {
  method: "POST",
  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 |
| --- | --- | --- | --- |
| `found` | integer | Yes | How many product groups the scan proposed. |
| `gaps` | integer | Yes | How many groups the shop almost has, with a product missing. |

### Example response

```json title="200"
{
  "found": 7,
  "gaps": 2
}
```

## 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](https://panlytics.net/developers/security/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. |
| 429 | `limit.said` |  | Wait for the next hour, or ask us to raise it. |
| 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. |
| 503 | `agent.empty` | The assistant came back with nothing. | Send it again; if it keeps happening, report it. |
| 503 | `unavailable.said` |  | Wait a minute and try again; if it keeps happening, report it. |