# Kabum — 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 KaBuM!'s vast electronics catalog, get detailed product specifications and customer reviews, and explore categories and departments. Find exactly what you need with search suggestions and deep product information from Brazil's top electronics retailer.

**Category:** E-commerce | **Website:** [kabum.com.br/](https://kabum.com.br/) | **Docs:** [parse.bot/marketplace/773e8a6f-598a-438b-a326-aeac532f2f8d/kabum-com-br-api](https://parse.bot/marketplace/773e8a6f-598a-438b-a326-aeac532f2f8d/kabum-com-br-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/kabum/`
**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 category products

Browse products within a specific category by slug. Returns paginated product listings. Use get_departments_and_categories to discover valid category slugs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_slug` | string | Yes | Category slug from get_departments_and_categories (e.g. 'hardware', 'computadores', 'perifericos'). |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of items per page. |

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

### Get departments and categories

Get the full hierarchy of departments and categories available on KaBuM!. Returns category codes, slugs, names, and image URLs. Use the 'amigavel' field as the category_slug for get_category_products.

**Estimated cost:** Metered

_No parameters required._

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

### Get product details

Get detailed product information including pricing, technical specifications, images, payment methods, ratings, and seller info. Requires both the numeric product ID and the URL slug. The slug is obtainable from the product URL returned by search_products.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_id` | string | Yes | Numeric product ID (e.g. '955187'). Obtainable from search_products results. |
| `slug` | string | Yes | Product URL slug/friendly name (e.g. 'notebook-lenovo-ideapad-slim-3-amd-ryzen-7'). Obtainable from the product URL in search_products results. |

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

### Get product reviews

Get user reviews for a specific product. Returns paginated reviews with scores, titles, descriptions, and metadata. Paginates via page number. Products without reviews return an empty reviews array.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of reviews per page. |
| `page` | integer | No | Page number for pagination. |
| `product_id` | string | Yes | Product ID (e.g. '955187'). Obtainable from search_products results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/kabum/get-product-reviews \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>","product_id":"<string>"}'
```

### Get search suggestions

Get catalog search results with full metadata including filters, pagination links, and detailed product attributes. Returns raw catalog data for a search query including breadcrumbs, SEO info, and available filters.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | The search term (e.g. 'RTX 4060', 'monitor'). |

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

### Search products

Full-text search over KaBuM!'s product catalog by keyword. Returns paginated product summaries including prices, availability, ratings, and seller info. Paginates via page number. Each product carries an id and slug usable for get_product_details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of items per page. |
| `query` | string | Yes | Search keyword (e.g. 'notebook', 'RTX 4060'). |
| `sort` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/kabum/search-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>","query":"<string>","sort":"<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.