# Furniture — 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 and browse Furniture.com's product catalog by keywords, then narrow results using filters like color, material, style, type, and brand. Sort by price or ratings and navigate through results with pagination to find the perfect furniture for your needs.

**Category:** E-commerce | **Website:** [www.furniture.com/](https://www.furniture.com/) | **Docs:** [parse.bot/marketplace/5469ed0b-c63f-4499-9f57-abbb2d0ab2be/furniture-com-api](https://parse.bot/marketplace/5469ed0b-c63f-4499-9f57-abbb2d0ab2be/furniture-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/furniture/`
**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 filters

Get available filter facets and their option counts for a search query. Returns all filterable dimensions (color, material, style, type, brand, seller, price range) with the number of matching products for each option. Use to populate filter UIs or discover valid filter values before calling search_products.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | No | Search keyword to get filters for. |
| `zip_code` | string | No | 5-digit US ZIP code for availability context. |

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

### Search products

Full-text search over the Furniture.com product catalog. Returns paginated product listings with details including price, seller, images, specifications, variations, and availability. Supports facet filtering by color, material, style, type, brand, seller, and price range. Server-side sorting by recommendation score, price, or rating. Each page returns up to 50 products.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `brand` | string | No | Filter by brand (e.g. 'BenchMade Modern', 'Four Hands'). |
| `color` | string | No | Filter by color (e.g. 'Brown', 'Beige & Cream', 'Gray', 'Blue'). |
| `limit` | integer | No | Number of results per page (max 50). |
| `material` | string | No | Filter by material (e.g. 'Fabric', 'Leather', 'Wood', 'Velvet', 'Polyester'). |
| `max_price` | number | No | Maximum price filter. |
| `min_price` | number | No | Minimum price filter. |
| `on_sale` | string | No | Filter to on-sale items only. Pass 'true' to activate. |
| `page` | integer | No | Page number for pagination. |
| `query` | string | No | Search keyword (e.g. 'sofa', 'dining table', 'bed'). |
| `seller` | string | No | Filter by seller (e.g. 'Lulu and Georgia', 'Bloomingdale\'s'). |
| `sort_by` | string | No | Sort order for results. |
| `style` | string | No | Filter by style (e.g. 'Modern', 'Contemporary', 'Traditional', 'Mid-Century Modern'). |
| `type` | string | No | Filter by furniture type (e.g. 'Sofa', 'Stationary', 'Platform', 'Upholstered'). |
| `zip_code` | string | No | 5-digit US ZIP code for availability filtering. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/furniture/search-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"brand":"<string>","color":"<string>","limit":"<integer>","material":"<string>","max_price":"<number>","min_price":"<number>","on_sale":"<string>","page":"<integer>","query":"<string>","seller":"<string>","sort_by":"<string>","style":"<string>","type":"<string>","zip_code":"<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.