# Illy — 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.

> Browse illy's complete catalog of premium coffee products, machines, and gift sets while discovering reviews, availability, pricing, and promotional offers. Search for specific items by category, check subscription options, and get detailed product information and Q&A to find exactly what you're looking for.

**Category:** E-commerce | **Website:** [illy.com/](https://illy.com/) | **Docs:** [parse.bot/marketplace/1fae3ac2-9eee-433b-b137-1e59255814c6/illy-com-api](https://parse.bot/marketplace/1fae3ac2-9eee-433b-b137-1e59255814c6/illy-com-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/illy/`
**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

### Check product availability

Check if a product is in stock by fetching its product page and extracting availability from structured data. Returns a simplified availability status.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Product URL path starting with /en-us/ (e.g. /en-us/coffee/whole-bean-coffee/whole-bean-classico-coffee-medium-roast/8841ST.html) or full URL. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/illy/check-product-availability \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### Get product details

Get detailed information for a specific product by its URL path. Returns product name, description, SKU, price, currency, availability, images, and flavor intensity extracted from structured data on the product page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Product URL path starting with /en-us/ (e.g. /en-us/coffee/whole-bean-coffee/whole-bean-classico-coffee-medium-roast/8841ST.html) or full URL. |

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

### Get product qa

Get Q&A entries for a product via the PowerReviews API. Returns questions and their answers including expert and community responses.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_id` | string | Yes | Product ID/SKU (e.g. 8841ST). Available from the id field in product listing endpoints. |

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

### Get product reviews

Get customer reviews and ratings for a product via the PowerReviews API. Returns review rollup (average rating, counts) and individual reviews with details and metrics.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_id` | string | Yes | Product ID/SKU (e.g. 8841ST, 6607). Available from the id field in product listing endpoints. |

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

### Get promotions

Retrieve current promotions and deals from the illy.com offers page. Parses promotional content from the Livestory CMS wall. Results vary as promotions change over time.

**Estimated cost:** Metered

_No parameters required._

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

### List all coffee products

Retrieve all coffee products from illy.com with pagination support. Returns product listings including name, price, thumbnail, badge, and flavor intensity. The full catalog has 100+ products; use start/sz to paginate through them.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `start` | integer | No | Offset for pagination. |
| `sz` | integer | No | Number of products per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/illy/list-all-coffee-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"start":"<integer>","sz":"<integer>"}'
```

### List coffee by category

Retrieve coffee products filtered by category slug. Returns product listings for the specified category. Categories correspond to the tabs on the illy coffee page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Category slug for the coffee category path. Accepted values: whole-bean-coffee, iperespresso-espresso-capsules, ground-espresso-moka-coffee, ese-espresso-pods, compatible-capsules, k-cup-pods, instant-coffee. |
| `start` | integer | No | Offset for pagination. |
| `sz` | integer | No | Number of products per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/illy/list-coffee-by-category \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","start":"<integer>","sz":"<integer>"}'
```

### List coffee machines

Retrieve coffee machines and makers from illy.com with pagination support. Includes espresso machines, french presses, and moka pots.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `start` | integer | No | Offset for pagination. |
| `sz` | integer | No | Number of products per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/illy/list-coffee-machines \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"start":"<integer>","sz":"<integer>"}'
```

### List gifts and accessories

Retrieve gifts, accessories, cups, and other non-coffee products from illy.com with pagination support.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `start` | integer | No | Offset for pagination. |
| `sz` | integer | No | Number of products per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/illy/list-gifts-and-accessories \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"start":"<integer>","sz":"<integer>"}'
```

### Search products

Search for products by keyword across all illy.com product categories. Returns matching product listings with pagination support.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword (e.g. classico, espresso, latte). |
| `start` | integer | No | Offset for pagination. |
| `sz` | integer | No | Number of results per page. |

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

## 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.