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

> Search and browse Lidl US grocery products to find current prices, promotions, and real-time stock availability across store locations. Explore products by category and compare deals to plan your shopping trips efficiently.

**Category:** Food & Dining | **Website:** [lidl.com/](https://lidl.com/) | **Docs:** [parse.bot/marketplace/77eb6e76-2a8f-4db3-b832-449fbf24b7fb/lidl-com-api](https://parse.bot/marketplace/77eb6e76-2a8f-4db3-b832-449fbf24b7fb/lidl-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/lidl/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get categories

List all product categories available at a specific Lidl store. Returns a hierarchical category tree with parent references and product counts. Use category codes with get_category_products to browse by category.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `store_id` | string | No | Lidl store ID in format US followed by digits (e.g. 'US01053' for Culpeper VA). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lidl/get-categories \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"store_id":"<string>"}'
```

### Get category products

Get all products in a specific category at a Lidl store. Returns paginated product listings with prices and stock information. Use category codes from get_categories endpoint.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_code` | string | Yes | Category code from get_categories (e.g. 'OCI2000110' for milk & creamers, 'OCI1000079' for dairy). |
| `limit` | integer | No | Maximum number of results to return per page. |
| `offset` | integer | No | Number of results to skip for pagination. |
| `store_id` | string | No | Lidl store ID in format US followed by digits (e.g. 'US01053' for Culpeper VA). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lidl/get-category-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category_code":"<string>","limit":"<integer>","offset":"<integer>","store_id":"<string>"}'
```

### Search products

Search for grocery products by keyword at a specific Lidl store. Returns paginated results with prices, stock status, promotions, and aisle/section information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return per page. |
| `offset` | integer | No | Number of results to skip for pagination. |
| `query` | string | Yes | Search term for products (e.g. 'milk', 'bread', 'chicken'). |
| `store_id` | string | No | Lidl store ID in format US followed by digits (e.g. 'US01053' for Culpeper VA). Determines product availability and pricing. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lidl/search-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>","query":"<string>","store_id":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.