# Sephora on Onekey

> 11 endpoints for Sephora (0 stable, 11 beta), 2 credits each. Category: E-commerce & marketplaces. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 11 of 11 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/sephora
Reference (Markdown): https://onekey.dev/docs/api/sephora.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 11 mapped Sephora endpoints return each:

- `entity.name` (string): 10
- `entity.id` (string): 9
- `entity.url` (URL): 7
- `entity.description` (string): 5
- `entity.stats.rating` (number): 5
- `entity.stats.ratingCount` (integer): 5
- `media.thumbnailUrl` (URL): 5
- `listing.brand` (string): 4
- `listing.currency` (string): 4
- `listing.price` (number): 4
- `entity.slug` (string): 2
- `place.address` (string): 2
- `author.displayName` (string): 1
- `content.createdAt` (ISO 8601 date): 1
- `content.id` (string): 1
- `content.text` (string): 1
- `content.title` (string): 1
- `engagement.votes` (integer): 1
- `entity.type` (string): 1
- `listing.available` (boolean): 1
- `place.city` (string): 1
- `place.lat` (number): 1
- `place.lon` (number): 1
- plus 3 platform-specific fields under `ext.`

## Endpoints

### sephora.availability

In-store availability of a Sephora SKU near a coordinate.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/availability?sku=2210581&latitude=40.7128&longitude=-74.0060` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `sku` (string, required): Product SKU
  - `latitude` (string, optional): Latitude in decimal degrees
  - `longitude` (string, optional): Longitude in decimal degrees
  - `location_coordinate` (string, optional): Coordinates as 'latitude,longitude' (alternative to latitude + longitude)
- Fields returned: `entity.id`, `entity.name`, `listing.available`, `place.address`, `ext.quantity`
- Reference: https://onekey.dev/docs/api/sephora/availability.md

### sephora.brand_products

Products of a Sephora brand.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/brand_products?id=gucci` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Brand short name from the brands endpoint, e.g. gucci
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/sephora/brand_products.md

### sephora.brands

List Sephora brands.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/brands` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `entity.stats.rating`, `entity.stats.ratingCount`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/sephora/brands.md

### sephora.categories

List Sephora root categories.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/categories` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.slug`
- Reference: https://onekey.dev/docs/api/sephora/categories.md

### sephora.category

Browse Sephora products in a category.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/category?category_id=cl94` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `category_id` (string, required): Category id or slug, as returned by the categories endpoint
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/sephora/category.md

### sephora.category_data

A Sephora category and its children.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/category_data?id=gucci` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Sephora category id from the categories endpoint, e.g. cat1100057
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.slug`
- Reference: https://onekey.dev/docs/api/sephora/category_data.md

### sephora.product

A Sephora product by id.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/sephora/product?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/sephora/product.md

### sephora.reviews

Sephora product reviews.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/reviews?product_id=123456789` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `product_id` (string, optional): Product id as it appears on the product page URL
  - `url` (string, optional): Full URL of the product page (alternative to the id)
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `author.displayName`, `engagement.votes`, `ext.rating`
- Reference: https://onekey.dev/docs/api/sephora/reviews.md

### sephora.search

Search Sephora products by keyword.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/search?query=headphones` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `listing.brand`, `entity.stats.rating`, `entity.stats.ratingCount`
- Reference: https://onekey.dev/docs/api/sephora/search.md

### sephora.search_suggestions

Search suggestions for Sephora.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/search_suggestions?query=headphones` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
- Fields returned: `entity.name`, `entity.type`
- Reference: https://onekey.dev/docs/api/sephora/search_suggestions.md

### sephora.stores

Sephora stores near a coordinate.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/sephora/stores?latitude=40.7128&longitude=-74.0060` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `latitude` (string, optional): Latitude in decimal degrees
  - `longitude` (string, optional): Longitude in decimal degrees
  - `location_coordinate` (string, optional): Coordinates as 'latitude,longitude' (alternative to latitude + longitude)
- Fields returned: `entity.id`, `entity.name`, `place.address`, `place.city`, `place.lat`, `place.lon`, `ext.phone`
- Reference: https://onekey.dev/docs/api/sephora/stores.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/sephora/product?product_id=123456789" \
  -H "x-api-key: YOUR_API_KEY"
```