# Shopify on Onekey

> 6 endpoints for Shopify (6 stable, 0 beta), 1 to 5 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.

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

## Canonical fields returned

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

- `entity.name` (string): 6
- `entity.description` (string): 5
- `media.thumbnailUrl` (URL): 5
- `content.createdAt` (ISO 8601 date): 4
- `content.id` (string): 4
- `entity.category` (string): 4
- `listing.available` (boolean): 4
- `listing.price` (number): 4
- `content.updatedAt` (ISO 8601 date): 3
- `entity.tags` (list of strings): 3
- `listing.sku` (string): 3
- `entity.id` (string): 2
- `entity.country` (string): 1
- `listing.currency` (string): 1
- `place.city` (string): 1
- plus 4 platform-specific fields under `ext.`

## Endpoints

### shopify.collection_products

Products in one collection of an allowlisted Shopify storefront.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/shopify/collection_products?domain=www.allbirds.com&handle=womens` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `domain` (string, required): Storefront domain (allowlist only), e.g. www.allbirds.com
  - `handle` (string, required): Collection handle
- Fields returned: `content.id`, `entity.name`, `entity.description`, `content.createdAt`, `content.updatedAt`, `entity.category`, `entity.tags`, `listing.price`, `listing.sku`, `listing.available`, `media.thumbnailUrl`, `ext.handle`, `ext.vendor`
- Reference: https://onekey.dev/docs/api/shopify/collection_products.md

### shopify.collections

List collections of an allowlisted Shopify storefront.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/shopify/collections?domain=www.allbirds.com` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `domain` (string, required): Storefront domain (allowlist only), e.g. www.allbirds.com
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `content.createdAt`, `media.thumbnailUrl`, `ext.handle`, `ext.products`
- Reference: https://onekey.dev/docs/api/shopify/collections.md

### shopify.product

One product of an allowlisted Shopify storefront by handle.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/shopify/product?domain=www.allbirds.com&handle=mens-tree-runners` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `domain` (string, required): Storefront domain (allowlist only), e.g. www.allbirds.com
  - `handle` (string, required): Product handle
- Fields returned: `content.id`, `entity.name`, `entity.description`, `content.createdAt`, `content.updatedAt`, `entity.category`, `entity.tags`, `listing.price`, `listing.sku`, `listing.available`, `media.thumbnailUrl`, `ext.handle`, `ext.vendor`
- Reference: https://onekey.dev/docs/api/shopify/product.md

### shopify.products

List products of an allowlisted Shopify storefront (public products.json).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/shopify/products?domain=www.allbirds.com&page=1` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `domain` (string, required): Storefront domain (allowlist only), e.g. www.allbirds.com
  - `page` (string, optional, default 1): Page (1-based)
- Fields returned: `content.id`, `entity.name`, `entity.description`, `content.createdAt`, `content.updatedAt`, `entity.category`, `entity.tags`, `listing.price`, `listing.sku`, `listing.available`, `media.thumbnailUrl`, `ext.handle`, `ext.vendor`
- Reference: https://onekey.dev/docs/api/shopify/products.md

### shopify.search_suggest

Predictive product search of an allowlisted Shopify storefront.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/shopify/search_suggest?domain=www.allbirds.com&q=shoe` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `domain` (string, required): Storefront domain (allowlist only), e.g. www.allbirds.com
  - `q` (string, required): Search query
- Fields returned: `content.id`, `entity.name`, `entity.description`, `listing.price`, `entity.category`, `listing.available`, `media.thumbnailUrl`, `ext.handle`, `ext.vendor`
- Reference: https://onekey.dev/docs/api/shopify/search_suggest.md

### shopify.shop

Public shop metadata (meta.json) of an allowlisted Shopify storefront.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/shopify/shop?domain=www.allbirds.com` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `domain` (string, required): Storefront domain (allowlist only), e.g. www.allbirds.com
- Fields returned: `entity.id`, `entity.name`, `place.city`, `entity.country`, `listing.currency`, `ext.domain`, `ext.products`
- Reference: https://onekey.dev/docs/api/shopify/shop.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/shopify/product?domain=www.allbirds.com&handle=mens-tree-runners" \
  -H "x-api-key: YOUR_API_KEY"
```