# List Categories

List Lidl's localized top-level online category taxonomy for GB, DE, or FR, including product counts and actionable first-party category API URLs.

- Platform: [Lidl](https://docs.upscrape.com/docs/platforms/lidl)
- Capability ID: `lidl.categories.list`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "country": "GB"
  },
  "capability": "lidl.categories.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `country` | `string` | No |  |

### Example input

```json
{
  "country": "GB"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "categories": [
    {
      "count": 305,
      "id": "10068374",
      "label": "Food & Drink",
      "url": "https://www.lidl.co.uk/q/api/search?assortment=GB&locale=en_GB&version=v2.0.0&category=Food+%26+Drink"
    },
    {
      "count": 7,
      "id": "10068166",
      "label": "Kitchen & Household",
      "url": "https://www.lidl.co.uk/q/api/search?assortment=GB&locale=en_GB&version=v2.0.0&category=Kitchen+%26+Household"
    },
    {
      "count": 52,
      "id": "10068222",
      "label": "DIY & Garden",
      "url": "https://www.lidl.co.uk/q/api/search?assortment=GB&locale=en_GB&version=v2.0.0&category=DIY+%26+Garden"
    }
  ],
  "country": "GB"
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `categories` | `array` | 3 items |
| `categories` | `array` | 3 items |
| `country` | `string` | GB |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)