# Wellcome Hong Kong — 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 Wellcome Hong Kong's online grocery store, view detailed product information, explore categories, and see what other shoppers are searching for. Discover trending items and get product suggestions to streamline your grocery shopping experience.

**Category:** Food & Dining | **Website:** [wellcome.com.hk/](https://wellcome.com.hk/) | **Docs:** [parse.bot/marketplace/3741457b-8768-4c6c-99a5-c125f419342d/wellcome-com-hk-api](https://parse.bot/marketplace/3741457b-8768-4c6c-99a5-c125f419342d/wellcome-com-hk-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/wellcome-hong-kong/`
**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

### Browse category

Browse products within a category by ID. Returns paginated product summaries, hierarchical subcategories (up to 3 levels deep), and available filter facets. Use subcategories from the response to discover narrower category IDs for drill-down.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Category ID (e.g., '100002' for Beverages). Top-level categories can be discovered from subcategories in the response. |
| `page` | integer | No | Page number (1-based) |
| `page_size` | integer | No | Results per page |

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

### Get product detail

Fetch full product information by SKU ID. Returns brand, category, price, images, structured attributes (origin, storage, specs), active promotions, and HTML/text descriptions. The sku_id is obtained from search_products or browse_category results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `sku_id` | string | Yes | Product SKU ID (obtained from search_products or browse_category results) |

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

### Popular searches

Current popular/trending search terms on Wellcome. Returns ranked keywords that are currently trending on the platform. No parameters required.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wellcome-hong-kong/popular-searches \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search products

Full-text search over Wellcome's grocery catalog. Supports English and Chinese keywords. Returns paginated product summaries, total counts, and available filter facets (category, brand, origin). Sort by price or new arrivals; default sort is relevance. Each product summary exposes a sku_id for fetching full detail via get_product_detail.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `keyword` | string | Yes | Search keyword (English or Chinese) |
| `page` | integer | No | Page number (1-based) |
| `page_size` | integer | No | Results per page |
| `sort_key` | integer | No | Sort field: 0=default/relevance, 1=price, 2=new arrivals |
| `sort_rule` | integer | No | Sort direction: 0=ascending, 1=descending |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wellcome-hong-kong/search-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"<string>","page":"<integer>","page_size":"<integer>","sort_key":"<integer>","sort_rule":"<integer>"}'
```

### Search suggestions

Autocomplete suggestions for a keyword prefix. Returns suggested keywords ranked by relevance score (higher is more relevant). Useful for building type-ahead search UIs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `keyword` | string | Yes | Search keyword prefix for autocomplete suggestions |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wellcome-hong-kong/search-suggestions \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"<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.