# Retailmenot — 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 grocery and retail coupons, promo codes, and cash back offers across thousands of merchants to find the best deals before you shop. Get instant access to current discounts and savings opportunities tailored to your favorite stores and products.

**Category:** E-commerce | **Website:** [retailmenot.com/](https://retailmenot.com/) | **Docs:** [parse.bot/marketplace/13b99958-e9b3-4de3-aae1-100bf017113c/retailmenot-com-api](https://parse.bot/marketplace/13b99958-e9b3-4de3-aae1-100bf017113c/retailmenot-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/retailmenot/`
**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 store coupons

Fetches all current coupons from a specific store's RetailMeNot page. Accepts a store_slug (e.g. 'target.com') and returns the same coupon object shape as search_coupons plus a scraped_at ISO 8601 timestamp indicating when the response was generated. Makes up to 2 requests: one for the store page and one to reveal coupon codes. When codes_only is true, only coupons with an actual promo code string are included in results; sales, cash back, and other non-code offers are excluded.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `codes_only` | boolean | No | When true, only coupons with an actual promo code are returned. Sales, cash back, and other non-code offers are excluded from the results and from the total count. |
| `store_slug` | string | Yes | Store identifier as it appears in the RetailMeNot URL path (e.g. 'target.com', 'amazon.com'). Discoverable via get_stores endpoint. |

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

### Get stores

Discovers all store pages from RetailMeNot's sitemap.xml. Returns a list of stores with their slug, derived name, and full URL. Makes a single request to the sitemap; no sub-sitemaps are followed. Typically returns ~6000+ stores.

**Estimated cost:** Metered

_No parameters required._

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

### Search coupons

Search for coupons and promo codes by keyword. Resolves the query to the best matching category or store page on RetailMeNot, then returns all available coupons from that page. Results include coupon codes, sales, and cash back offers with discount amounts and store attribution. For coupon-type offers, the actual promo code string is included when available.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | No | Search term for finding coupons (e.g. 'grocery', 'pizza', 'electronics'). Matched against RetailMeNot categories and store names. |

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