shopify.product

stable Standard

One product of an allowlisted Shopify storefront by handle.

GET /v1/shopify/product

What you get#

One Shopify record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`domain`	string	yes	(required)	Storefront domain (allowlist only), e.g. www.allbirds.com	max 61 chars; must match `[a-z0-9][a-z0-9.-]{3,60}`; trimmed, lowercased
`handle`	string	yes	(required)	Product handle	max 255 chars; must match `[a-z0-9][a-z0-9_-]{0,254}`; trimmed, lowercased

Request#

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

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Shopify response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "content": {
      "id": "4870548979792",
      "createdAt": "2026-09-25T23:57:46Z",
      "updatedAt": "2026-09-28T20:00:31Z"
    },
    "entity": {
      "name": "Men's Tree Runner - Jet Black (White Sole)",
      "description": "The Allbirds Tree Runner is a breathable and lightweight sneaker made with responsibly sourced eucalyptus tree fiber that feels silky smooth and cool on your skin. These shoes are perfect for everyday casual wear, walking, and warmer weather.",
      "category": "Shoes",
      "tags": "allbirds::carbon-score => 4.52, allbirds::cfId => color-mens-tree-runners-jet-black-white, allbirds::complete => true, allbirds::edition => classic, allbirds::gender => mens, allbirds::hue => black, allbirds::master => mens-tree-runners, allbirds::material => tree, allbirds::price-tier => msrp, allbirds::silhouette => runner, allbirdskit::kit-discount-2pPynpFQ2oCKNjoEN1KjVb => 18, allbirdskit::kit-id => 2pPynpFQ2oCKNjoEN1KjVb, allbirdskit::kit-size-2pPynpFQ2oCKNjoEN1KjVb => 2, loop::returnable => true, OOS DNS, shoprunner, WC WAVE 1 TRUCK #1-#16 7.30.2026, YCRF_mens-move-shoes, YGroup_ygroup_mens-tree-runners"
    },
    "ext": {
      "handle": "mens-tree-runners",
      "vendor": "Allbirds"
    },
    "listing": {
      "price": 100,
      "sku": "TR3MJBW080",
      "available": null
    },
    "media": {
      "thumbnailUrl": "https://cdn.shopify.com/s/files/1/1104/4168/files/TR3MJBW080_SHOE_LEFT_GLOBAL_MENS_TREE_RUNNER_JET_BLACK_WHITE.png?v=1751165486"
    }
  },
  "metadata": {
    "platform": "shopify",
    "endpoint": "product",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`content.id`	`toString`
`title`	`entity.name`	-
`handle`	`ext.handle`	-
`body_html`	`entity.description`	`stripHtml`
`published_at`	`content.createdAt`	`toIsoDate`
`updated_at`	`content.updatedAt`	`toIsoDate`
`vendor`	`ext.vendor`	-
`product_type`	`entity.category`	-
`tags`	`entity.tags`	-
`variants.0.price`	`listing.price`	`toNumber`
`variants.0.sku`	`listing.sku`	-
`variants.0.available`	`listing.available`	`toBoolean`
`images.0.src`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).