Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-shop
string
required

Shopify store URL. Resolves the shop for the request (headless does not accept ?shop=).

Example:

"shop.myshopify.com"

Body

application/json

Request body

Config request. Union of the legacy instant-config and search-config inputs.

locale
string
default:en-US

BCP-47 locale for translations and locale-aware indexes.

Example:

"en-US"

market
integer

Shopify market id for market-aware pricing / catalog.

theme
integer

Theme id. Accepted for parity with the storefront config API; NOT used to render templates (headless responses carry no templates).

target_page
enum<string>
default:search

Which page's filter tree to resolve.

Available options:
search,
collection
target_id
integer

Target object id (e.g. collection id) when target_page is collection.

skip_cache
boolean
default:false

Bypass the cached config and recompute.

visitor_id
string

Anonymous device/browser UID (the gl_s_uid cookie). The primary personalization key; stays stable when a customer logs in.

client_id
string

Per-session / per-device identifier.

customer_id
string

Shopify customer id. Present only when the shopper is logged in; enables customer-level personalization.

Response

Search configuration

Config for all three features plus filter definitions, tree, shop, analytics, translations and token.

config
object

Merged instant / search / image feature config. No Liquid templates, no widget css/js.

filters
object[]

Facet (filter) definitions for the resolved tree.

filter_tree
object | null

Resolved filter tree, or null when none exists.

shop
object

Minimal shop context.

analytics
object

Analytics configuration.

translations
object

Translation bundle for the requested locale.

token
string | null

Shopify storefront access token for direct Storefront API calls.

metadata
object

Response metadata.