What you get#
Onekey exposes Shopify as 6 endpoints behind one API key: 2 endpoints return one record (data is an object) and 4 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Shopify also works for the rest of the e-commerce & marketplaces category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
collection_products | Products in one collection of an allowlisted Shopify storefront. | domain*, handle* | 5 | stable |
collections | List collections of an allowlisted Shopify storefront. | domain* | 5 | stable |
product | One product of an allowlisted Shopify storefront by handle. | domain*, handle* | 1 | stable |
products | List products of an allowlisted Shopify storefront (public products.json). | domain*, page | 5 | stable |
search_suggest | Predictive product search of an allowlisted Shopify storefront. | domain*, q* | 5 | stable |
shop | Public shop metadata (meta.json) of an allowlisted Shopify storefront. | domain* | 1 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls shopify.product (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/shopify/product?domain=www.allbirds.com&handle=mens-tree-runners" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Shopify, with the same names as on every other platform. The count is how many of its 6 mapped endpoints return the field; a field the source lacks is null, never missing. 4 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
Shopify calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.