shopify.search_suggest

stable Advanced

Predictive product search of an allowlisted Shopify storefront.

GET /v1/shopify/search_suggest

What you get#

A list of Shopify results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits 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
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/shopify/search_suggest?domain=www.allbirds.com&q=shoe" \
  -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": "7215610724432"
      },
      "entity": {
        "name": "Women's Canvas Cruiser - Port (Natural White Sole)",
        "description": "Classic court style, relaxed for warmer days. Cruiser Canvas pairs a familiar silhouette with a subtly textured hemp-and-cotton upper that feels light, breathable, and ready to wear on repeat. Comfortable enough for all day. Simple enough to go with everything.",
        "category": "Shoes"
      },
      "ext": {
        "handle": "womens-cruiser-canvas-port",
        "vendor": "Allbirds"
      },
      "listing": {
        "price": 75,
        "available": true
      },
      "media": {
        "thumbnailUrl": "https://cdn.shopify.com/s/files/1/1104/4168/files/A12848_26Q1_Cruiser-Canvas-Port-Natural-White-Sole_PDP_LEFT_f544c3ab-bb93-4f19-9cb0-558975e64068.png?v=1774478056"
      }
    },
    {
      "content": {
        "id": "6565493899344"
      },
      "entity": {
        "name": "Women's Tree Piper - Moonrise (White Sole)",
        "description": "The Tree Piper is a classic low-top silhouette that's been reimagined for everyday casual wear while walking in warmer weather. It's made with lightweight, breathable, and comfortable natural materials, and is all about balancing simplicity and exaggeration for versatile styling.",
        "category": "Shoes"
      },
      "ext": {
        "handle": "womens-tree-pipers",
        "vendor": "Allbirds"
      },
      "listing": {
        "price": 105,
        "available": true
      },
      "media": {
        "thumbnailUrl": "https://cdn.shopify.com/s/files/1/1104/4168/files/TP1MMOO_TREE_PIPER_LEFT_GLOBAL_MOONRISE_WHITE.png?v=1776804757"
      }
    }
  ],
  "metadata": {
    "platform": "shopify",
    "endpoint": "search_suggest",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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`	`entity.description`	`stripHtml`
`price`	`listing.price`	`toNumber`
`vendor`	`ext.vendor`	-
`type`	`entity.category`	-
`available`	`listing.available`	`toBoolean`
`image`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes 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 hour more (marked stale).
A "not found" is remembered for 1 minute 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`	Unknown endpoint path.
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).