# Westelm — 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 West Elm's furniture and home décor catalog by keyword, browse autocomplete suggestions, and filter results by price, style, color, and other attributes. Sort products by relevance, price, or rating and paginate through results.

**Category:** E-commerce | **Website:** [www.westelm.com/](https://www.westelm.com/) | **Docs:** [parse.bot/marketplace/a05d3a13-9001-44ff-97f5-881d061a7009/westelm-com-api](https://parse.bot/marketplace/a05d3a13-9001-44ff-97f5-881d061a7009/westelm-com-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/westelm/`
**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

### Autocomplete

Get autocomplete suggestions and matching products for a partial search query. Useful for building search-as-you-type interfaces. Returns both search term suggestions and a small set of product previews matching the partial query.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `num_products` | integer | No | Number of product suggestions to return |
| `num_suggestions` | integer | No | Number of search term suggestions to return |
| `query` | string | Yes | Partial search query (e.g., 'sof', 'lamp', 'tab') |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/westelm/autocomplete \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"num_products":"<integer>","num_suggestions":"<integer>","query":"<string>"}'
```

### Search products

Search for products by keyword with support for pagination, sorting, and faceted filtering. Returns product details including prices, descriptions, images, and available filter facets. Paginates via integer page counter; each page returns up to page_size products. Facets in the response enumerate the available filter names and values for refining subsequent searches.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filters` | string | No | JSON object of facet filters, e.g. {"productType": "Sofa", "fabric": "Velvet"}. Available facet names and values are returned in the facets array of search results. |
| `page` | integer | No | Page number (1-based) |
| `page_size` | integer | No | Number of results per page (1-100) |
| `query` | string | Yes | Search keyword (e.g., 'sofa', 'desk', 'lamp') |
| `sort_by` | string | No | Sort field: relevance, lowestPrice, highestPrice, name, newcore. Omitting uses the site default (relevance). |
| `sort_order` | string | No | Sort direction: ascending or descending |

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