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

> Access data from colruyt.be.

**Category:** Food & Dining | **Website:** [colruyt.be/](https://colruyt.be/) | **Docs:** [parse.bot/marketplace/45c1d277-6088-4d5b-bd8d-d5828fa58bf5/colruyt-be-api](https://parse.bot/marketplace/45c1d277-6088-4d5b-bd8d-d5828fa58bf5/colruyt-be-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-colruyt-be-api-45c1d277/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_product_details

Retrieve full product details for a single Colruyt product by its identifier. Accepts a commercial article number, technical article number, or GTIN barcode. Returns comprehensive metadata including name, brand, pricing, nutritional scores, eco/green scores, availability, channel availability, images, and promotion status. One upstream API round-trip plus a session warmup round-trip. Returns stale_input (input_not_found) when no product matches the identifier.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `place_id` | string | No | Colruyt store place ID for pricing and availability context. Default is Colruyt Halle (604). |
| `product_id` | string | Yes | Product identifier: a commercial article number (e.g. '24583'), technical article number (e.g. '4862636'), or GTIN barcode (e.g. '05400141506532'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-colruyt-be-api-45c1d277/get_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"place_id":"<string>","product_id":"<string>"}'
```

### get_promotions

List current promotions available at a Colruyt store. Returns promotion details including discount benefits, linked products, validity dates, and brands. Results are paginated via page/size parameters. Each request includes a session warmup round-trip.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `place_id` | string | No | Colruyt store place ID. Default is Colruyt Halle (604). |
| `size` | integer | No | Number of promotions per page (1-100). |
| `sort` | string | No | Sort order for promotions (e.g. 'highestsalesrank asc'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-colruyt-be-api-45c1d277/get_promotions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","place_id":"<string>","size":"<integer>","sort":"<string>"}'
```

### get_stores

List all Colruyt stores in Belgium with place_id, store name, address, and geo-coordinates. Returns the full set of ~267 active stores in a single request (no pagination). Use the returned place_id values as the store scope input for search_products, get_promotions, and get_product_details.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-colruyt-be-api-45c1d277/get_stores \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_products

Search Colruyt products by keyword. Returns product metadata including prices, brand, nutritional scores, availability, and promotion status. Results are paginated via page/size parameters; omitting page defaults to page 1. Each request warms up a session before calling the upstream API, so latency includes one warmup round-trip.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `place_id` | string | No | Colruyt store place ID for availability and pricing context. Default is Colruyt Halle (604). |
| `query` | string | Yes | Search keyword (e.g. 'melk', 'bier', 'cola'). |
| `size` | integer | No | Number of products per page (1-100). |
| `sort` | string | No | Sort order string as accepted by the upstream API (e.g. 'relevancy asc', 'price asc', 'price desc'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-colruyt-be-api-45c1d277/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","place_id":"<string>","query":"<string>","size":"<integer>","sort":"<string>"}'
```