# Shopee (Brazil) — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 for products on Shopee Brazil (shopee.com.br) and retrieve detailed information including item specifications, customer reviews, and seller profiles. Browse the complete category tree to discover products across all sections of the marketplace, and explore official shops, flash sales, and search suggestions.

**Category:** E-commerce | **Website:** [shopee.com.br/](https://shopee.com.br/) | **Docs:** [parse.bot/marketplace/5e75c2d6-2d44-4999-a883-67291f5c8dae/shopee-com-br-api](https://parse.bot/marketplace/5e75c2d6-2d44-4999-a883-67291f5c8dae/shopee-com-br-api)

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

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/shopee-brazil/`
**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 tree

Get the full category hierarchy.

**Estimated cost:** Metered

_No parameters required._

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

### Get flash sale sessions

Get current flash sale sessions.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/shopee-brazil/get-flash-sale-sessions \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get official shops

Get a paginated list of official/branded shops on Shopee Brazil. Returns shop names, numeric IDs, logos, and brand information. Supports offset-based pagination. The total field indicates total available official shops across all pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of shops to return per page (max observed: 20). |
| `offset` | integer | No | Pagination offset (number of shops to skip). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/shopee-brazil/get-official-shops \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>"}'
```

### Get product comments

Get customer reviews for a product.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filter` | integer | No | Rating filter (0: all, 1-5: stars) |
| `item_id` | string | Yes | Item ID |
| `limit` | integer | No | Number of reviews to return |
| `offset` | integer | No | Offset for pagination |
| `shop_id` | string | Yes | Shop ID |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/shopee-brazil/get-product-comments \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filter":"<integer>","item_id":"<string>","limit":"<integer>","offset":"<integer>","shop_id":"<string>"}'
```

### Get product details

Get detailed information for a specific product. Note: Subject to aggressive anti-crawler protection.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `item_id` | string | Yes | Product Item ID |
| `shop_id` | string | Yes | Shop ID |

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

### Get search hints

Get search keyword suggestions/autocomplete for a given keyword on Shopee Brazil. Returns related popular search terms that users frequently search for, useful for discovering trending products and refining searches. Each suggestion includes the keyword text, optional category binding, and a position rank.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `keyword` | string | Yes | Search keyword to get suggestions for. |

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

### Get shop info

Retrieve detailed information about a shop/seller on Shopee Brazil including name, rating, follower count, item count, response rate, and shop rating breakdown. Requires a valid numeric shop_id which can be obtained from the get_official_shops endpoint. Returns the full shop profile as Shopee serves it — fields vary by shop configuration (decorated vs non-decorated, vacation mode, etc).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `shop_id` | string | Yes | Numeric shop ID. Valid shop IDs can be obtained from the get_official_shops endpoint's shopid field. |

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

### Search products

Search for products on Shopee Brazil. Note: Subject to aggressive anti-crawler protection (error 90309999).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of items to return |
| `newest` | integer | No | Offset for pagination |
| `order` | string | No | Sort order (asc/desc) |
| `query` | string | Yes | Search keyword |
| `sort_by` | string | No | Sort criteria (relevancy, price, sales, rating) |

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

## Next steps

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