# Products Checkers — 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 products from Checkers South Africa's online store, compare prices, and discover current specials and deals. Explore the complete product catalog by category to find items and get detailed product information all in one place.

**Category:** E-commerce | **Website:** [products.checkers.co.za/](https://products.checkers.co.za/) | **Docs:** [parse.bot/marketplace/7de48d74-a6a6-4f85-b537-4e37ac014a3f/products-checkers-co-za-api](https://parse.bot/marketplace/7de48d74-a6a6-4f85-b537-4e37ac014a3f/products-checkers-co-za-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-products-checkers-co-za-api-7de48d74/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### browse_category

Browse products within a specific display category with pagination. Category IDs are obtained from get_category_tree. Returns paginated product listings identical in shape to search results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Display category ID from get_category_tree (e.g. '67075e5eff987811364007e6') |
| `page` | integer | No | Zero-indexed page number |
| `page_size` | integer | No | Number of items per page |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-products-checkers-co-za-api-7de48d74/browse_category \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","page":"<integer>","page_size":"<integer>"}'
```

### get_category_tree

Retrieve the full department and category hierarchy for browsing. Returns nested category structure with IDs, names, and levels. Category IDs are used as input to browse_category.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-products-checkers-co-za-api-7de48d74/get_category_tree \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_product_details

Retrieve full details for a specific product by its slug. Slugs are formatted as name-articleNumberUOM (e.g. 'clover-fresh-full-cream-milk-2l-10136729EA') and are provided in search and browse results. Returns detailed product info including breadcrumbs and display categories.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Product slug from search results (e.g. 'clover-fresh-full-cream-milk-2l-10136729EA') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-products-checkers-co-za-api-7de48d74/get_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### get_specials

Retrieve products currently on special/promotion with pagination. Returns products from the site's curated promotions with bonusBuy details describing the deal.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Zero-indexed page number |
| `page_size` | integer | No | Number of items per page |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-products-checkers-co-za-api-7de48d74/get_specials \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>"}'
```

### search_products

Full-text search across all products by keyword. Returns paginated results with comprehensive product data including name, price, description, images, barcodes, promotion status, and slug for detail lookups. Pagination is zero-indexed.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Zero-indexed page number |
| `page_size` | integer | No | Number of items per page |
| `query` | string | Yes | Search keyword |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-products-checkers-co-za-api-7de48d74/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>","query":"<string>"}'
```