Search
Grouped matches over the store's own published catalogue — products, collections, pages and posts, newest-first. type=all (default) answers the first page of every section; type=product (or collection, page, post) with starting_after/page walks one section's keyset. Product hits carry the same card and final customer price as products. Case-insensitive; never another store's rows.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Query Parameters
Search text (2 to 100 characters). Matches product titles and slugs, collection names and slugs, and page and post titles and slugs, ignoring letter case.
2 <= length <= 100Sections to return: all (default) answers the first page of every section; product, collection, page or post answers that one section, paged with starting_after or page.
Value in
- "all"
- "product"
- "collection"
- "page"
- "post"
- null
Items per section, 1 to 25 (default 5).
1 <= value <= 25Keyset cursor: the section next_cursor from the previous page. Single-type mode only.
length <= 2000Page number, 1 to 50. Single-type mode only; never combine with starting_after.
1 <= value <= 50Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store/search?q=midi&type=all&limit=5" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Store search results", "data": { "query": "midi", "type": "all", "sections": { "products": { "items": [ { "shop_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c11", "p_id": 31501, "title": "Cotton Midi Dress", "slug": "cotton-midi-dress", "excerpt": "Flared cotton midi with pockets, cut in New York.", "description": "Our signature flared midi in premium cotton, with side pockets and a concealed back zip. Cut and finished in our New York atelier.", "image": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card.webp", "thumbnail_image": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-thumb.webp", "video_url": null, "video_poster_url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card.webp", "type": "product", "commerce_mode": "shop", "currency": "USD", "price": "60.00", "discount_price": "51.00", "compare_at_price": "60.00", "is_price_from": false, "price_range": { "min": "60.00", "max": "60.00" }, "has_variants": true, "has_addons": false, "tax_inclusive": false, "purchase_mode": "buy", "negotiable": false, "price_per": null, "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "value": "15.00", "amount": "9.00", "final_price": "51.00", "image_url": "https://media.usequeek.com/uploads/stores/2207/discounts/spring-season.jpg" }, "discounts": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "value": "15.00", "amount": "9.00", "final_price": "51.00", "image_url": "https://media.usequeek.com/uploads/stores/2207/discounts/spring-season.jpg" } ], "media": { "thumbnail": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-thumb.webp", "image": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card.webp", "original": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress.jpg", "primary_variant_image": null, "image_variants": { "thumb": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-thumb.webp", "w": null, "h": null }, "card": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card.webp", "w": 480, "h": 600 }, "card2x": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card2x.webp", "w": 800, "h": 1000 }, "view": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-view.webp", "w": 1200, "h": 1500 }, "wa": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-wa.jpg", "w": 1080, "h": 1350 }, "original": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress.jpg", "w": 1200, "h": 1500 } }, "primary_variant_image_variants": null, "images": [ { "id": 77101, "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card.webp", "alt": "Cotton midi dress on a mannequin", "variants": { "thumb": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-thumb.webp", "w": null, "h": null }, "card": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card.webp", "w": 480, "h": 600 }, "card2x": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-card2x.webp", "w": 800, "h": 1000 }, "view": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-view.webp", "w": 1200, "h": 1500 }, "wa": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-wa.jpg", "w": 1080, "h": 1350 }, "original": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress.jpg", "w": 1200, "h": 1500 } } }, { "id": 77103, "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back-card.webp", "alt": "Cotton midi dress, back view", "variants": { "thumb": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back-thumb.webp", "w": null, "h": null }, "card": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back-card.webp", "w": 480, "h": 600 }, "card2x": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back-card2x.webp", "w": 800, "h": 1000 }, "view": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back-view.webp", "w": 1200, "h": 1500 }, "wa": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back-wa.jpg", "w": 1080, "h": 1350 }, "original": { "url": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress-back.jpg", "w": 1200, "h": 1500 } } } ] }, "inventory": { "in_stock": true, "tracking": true, "quantity": 18 }, "variant_summary": { "count": 3, "min_price": "60.00", "max_price": "60.00", "total_stock": 18, "tracks_inventory": true, "in_stock": true }, "variants_count": 3, "rating": 4.5, "review_count": 132, "flags": { "featured": false, "is_marketplace": false, "is_wholesale": false, "is_new": false }, "metafields": {}, "created_at": "2026-06-18T09:40:00+01:00", "updated_at": "2026-09-22T16:05:00+01:00", "shop": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "slug": "northwind-goods", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "rating": 4.7, "rating_count": 486, "distance": null, "distance_text": null, "delivery_fee": null, "currency": "USD" }, "distance": null, "distance_text": null, "delivery_fee": null }, { "shop_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c12", "p_id": 31502, "title": "Linen Head Scarf", "slug": "linen-head-scarf", "excerpt": "Hand-woven linen scarf in burnt orange.", "description": "Hand-woven linen head scarf in burnt orange with metallic striping. Two metres, ready to tie.", "image": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card.webp", "thumbnail_image": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-thumb.webp", "video_url": null, "video_poster_url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card.webp", "type": "product", "commerce_mode": "shop", "currency": "USD", "price": "18.00", "discount_price": "18.00", "compare_at_price": null, "is_price_from": false, "price_range": null, "has_variants": false, "has_addons": false, "tax_inclusive": false, "purchase_mode": "buy", "negotiable": false, "price_per": null, "discount": null, "discounts": [], "media": { "thumbnail": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-thumb.webp", "image": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card.webp", "original": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf.jpg", "primary_variant_image": null, "image_variants": { "thumb": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-thumb.webp", "w": null, "h": null }, "card": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card.webp", "w": 480, "h": 480 }, "card2x": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card2x.webp", "w": 800, "h": 800 }, "view": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-view.webp", "w": 1200, "h": 1200 }, "wa": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-wa.jpg", "w": 1080, "h": 1080 }, "original": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf.jpg", "w": 1200, "h": 1200 } }, "primary_variant_image_variants": null, "images": [ { "id": 77102, "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card.webp", "alt": "Burnt-orange linen head scarf, folded", "variants": { "thumb": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-thumb.webp", "w": null, "h": null }, "card": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card.webp", "w": 480, "h": 480 }, "card2x": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-card2x.webp", "w": 800, "h": 800 }, "view": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-view.webp", "w": 1200, "h": 1200 }, "wa": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf-wa.jpg", "w": 1080, "h": 1080 }, "original": { "url": "https://media.usequeek.com/uploads/stores/2207/linen-head-scarf.jpg", "w": 1200, "h": 1200 } } } ] }, "inventory": { "in_stock": true, "tracking": true, "quantity": 34 }, "variant_summary": null, "variants_count": 0, "rating": 4.9, "review_count": 58, "flags": { "featured": false, "is_marketplace": false, "is_wholesale": false, "is_new": false }, "metafields": {}, "created_at": "2026-07-02T13:15:00+01:00", "updated_at": "2026-09-22T16:05:00+01:00", "shop": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "slug": "northwind-goods", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "rating": 4.7, "rating_count": 486, "distance": null, "distance_text": null, "delivery_fee": null, "currency": "USD" }, "distance": null, "distance_text": null, "delivery_fee": null } ], "has_more": false, "next_cursor": null }, "collections": { "items": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c25", "name": "New Season", "slug": "new-season", "image": "https://media.usequeek.com/uploads/stores/2207/collections/new-season.jpg" } ], "has_more": false, "next_cursor": null }, "pages": { "items": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c71", "title": "About Northwind Goods", "slug": "about-us", "excerpt": "Thoughtfully cut fashion since 2019.", "type": "page" } ], "has_more": false, "next_cursor": null }, "posts": { "items": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c73", "title": "How to style prints without looking costumey", "slug": "how-to-style-prints", "excerpt": "Three rules for modern prints.", "type": "post" } ], "has_more": false, "next_cursor": null } } }, "has_more": false, "next_cursor": null}Instant search-as-you-type suggestions over the store's own catalogue — products, then collections, then query suggestions (at most 10). Cached per store, invalidated on catalogue changes.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Query Parameters
Text typed so far (1 to 100 characters). Suggestions are products, then collections, then query suggestions.
1 <= length <= 100Number of suggestions to return, 1 to 10 (default 10).
1 <= value <= 10Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store/search/autocomplete?q=mid&limit=10" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Autocomplete suggestions", "data": { "query": "mid", "items": [ { "type": "product", "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c11", "title": "Cotton Midi Dress", "slug": "cotton-midi-dress", "thumbnail_image": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress.jpg", "currency": "USD", "price": "60.00" }, { "type": "collection", "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c25", "name": "New Season", "slug": "new-season", "image": "https://media.usequeek.com/uploads/stores/2207/collections/new-season.jpg" }, { "type": "query", "text": "Cotton Midi Dress" } ] }, "has_more": false, "next_cursor": null}