Info
Development connections only: a store created for testing is password-gated, and every store/* read answers 401 storefront_password_required until the request carries the token this returns, in the X-Storefront-Token header (valid for expires_in seconds; rotating the password invalidates it). A wrong password is a 422 wrong_password; a live store answers 422 password_not_required and needs none.
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
Header 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.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/auth/storefront/password" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "password": "ember-quartz-harbor-42" }'{ "status": "success", "message": "Password accepted", "data": { "token": "eyJpdiI6IkV4YW1wbGVUb2tlbiIsInZhbHVlIjoiU2lnbmVkLWRldi1zdG9yZS10b2tlbiJ9", "expires_in": 86400, "cookie": "queek_dev_store" }}Name, slug, logo, description, currency, opening hours (is_open, message), address.
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
Header 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
curl -X GET "https://example.com/store/info" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Vendor retrieved", "data": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": 0, "distance_text": "0m away", "delivery_info": { "delivery_fee": "0.00", "delivery_time": "45-180 min", "pickup_enabled": true, "delivery_message": "Open until 21:00", "disable_delivery": false }, "is_open": true, "message": "Open until 21:00", "temporary_unavailable": false, "preorder_enabled": false, "tags": null, "tag": "fashion", "is_new": false, "featured": false, "service_type": "fashion", "commerce_mode": "shop", "notice": [], "slug": "northwind-goods", "service": null, "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "logo_variants": null, "banner_variants": null, "rating": 4.7, "rating_count": 486, "discounts": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "value": "15.00", "image_url": "https://media.usequeek.com/uploads/stores/2207/discounts/spring-season.jpg" } ], "open_time": "09:00", "close_time": "21:00", "address": "14 Mercer Street, New York, NY 10013", "area": "SoHo", "landmark": "Opposite the public library", "support_phone": "+12*******47", "country_code": "US", "phone_code": "1", "support_email": "he***@northwindgoods.example", "slogan": null, "short_description": null, "disable_order": false, "region_id": null, "min_order_price": "0.00", "is_test": false, "dev_store": false, "password_required": false, "indexable": true, "online_store_redirect": null, "is_closed": false, "currency": "USD", "timezone": "America/New_York" }}Published store locales, default language first: locale, is_primary (content language), is_default (served at the root address), path_prefix ("" on the default-language locale), hreflang, html_lang, dir. Pass locale on any localized read (products, categories, collections, pages, posts, galleries, policies) to render that locale; every localized answer also carries it back in Content-Language.
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
Header 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
curl -X GET "https://example.com/store/locales" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Store locales retrieved", "data": [ { "locale": "en", "name": "English", "native_name": "English", "is_primary": true, "is_default": true, "path_prefix": "", "hreflang": "en", "html_lang": "en", "dir": "ltr" }, { "locale": "fr", "name": "French", "native_name": "Français", "is_primary": false, "is_default": false, "path_prefix": "fr", "hreflang": "fr", "html_lang": "fr", "dir": "ltr" } ], "meta": { "online_store_redirect": null }}This store’s theme-string overrides for ?locale=: {locale, theme, strings} with flat dotted keys (theme-slug prefix stripped). Only the ACTIVE theme’s keys, only non-empty values. Primary, missing, unknown or unpublished locales answer strings: {} — never an error, never another store’s strings.
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
Header 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
curl -X GET "https://example.com/store/theme-strings" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Store theme strings retrieved", "data": { "locale": "fr", "theme": "allure", "strings": { "cart.title": "Votre panier", "cart.add": "Ajouter au panier" } }}