# Lidl (Germany) — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Find the latest weekly promotions and browse Lidl Germany's bestselling products across different categories to discover deals and availability. Search for specific items to quickly locate what you're looking for in Lidl's product catalog.

**Category:** E-commerce | **Website:** [lidl.de/](https://lidl.de/) | **Docs:** [parse.bot/marketplace/c1196609-1f12-4a33-a1a6-2a4f307ad7f2/lidl-de-api](https://parse.bot/marketplace/c1196609-1f12-4a33-a1a6-2a4f307ad7f2/lidl-de-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-lidl-de-api-c1196609/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_all_flyers

Retrieve all currently available Lidl Germany flyer PDFs with full metadata. Returns every active flyer from the promotional widget including names, validity date ranges, categories, PDF download URLs, page counts, file sizes, and thumbnail URLs. Typically 8–12 flyers are active at any time covering different promotional themes.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-lidl-de-api-c1196609/get_all_flyers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_category_products

Retrieve bestselling product IDs for a given category from Lidl Germany's online shop recommendations engine. Returns up to 50 product IDs ranked by popularity. Prices and descriptions are not available through this endpoint — use the IDs for cross-referencing or tracking.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_key` | string | Yes | Category key identifying the product category. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-lidl-de-api-c1196609/get_category_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_key":"<string>"}'
```

### get_weekly_promotions

Retrieve the latest weekly promotional flyer (Aktionsprospekt) with detailed product items. Fetches the current Aktionsprospekt from Lidl's leaflet widget, returning flyer metadata (validity dates, PDF URL) and a list of promotional products with IDs, titles, URLs, and page numbers. The flyer rotates weekly; items reflect the store's current in-store promotion cycle.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-lidl-de-api-c1196609/get_weekly_promotions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_products

Search for products by keyword. Maps the query to a matching category and returns bestseller product IDs for that category. Keyword matching is substring-based: 'baby'/'spiel'/'kind' → baby-kind-spielzeug, 'essen'/'trink'/'milch'/'lebensmittel' → essen-trinken, 'wein'/'spirit'/'bier'/'alkohol' → wein-spirituosen, 'mode'/'kleid'/'schuh'/'accessoire' → mode-accessoires. Unmatched queries return an empty result with a note listing available categories.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword. Matched against known category keywords: baby/spiel/kind, essen/trink/milch/lebensmittel, wein/spirit/bier/alkohol, mode/kleid/schuh/accessoire. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-lidl-de-api-c1196609/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```