Get the store
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example?include_config=false&include_settings=false&include_embedded_scripts=false';const options = { method: 'GET', headers: {'x-store-preview': 'example', 'x-storefront-api-key': '<x-storefront-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/public/stores/example?include_config=false&include_settings=false&include_embedded_scripts=false' \ --header 'x-store-preview: example' \ --header 'x-storefront-api-key: <x-storefront-api-key>'Returns the store’s public details: name, domains, settings such as currency, logo and social links, the published theme and its values, embedded scripts and the shop metafields that are visible to the storefront. The response is cached for up to five minutes. A store that is suspended, disabled or still coming soon answers with an error, except for a request that carries a valid preview token.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s reference.
Query Parameters
Section titled “Query Parameters”Accepted for compatibility. The store’s domains are always returned.
Accepted for compatibility. The store’s settings are always returned.
Accepted for compatibility. The store’s embedded scripts are always returned.
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The store, or an empty body when no store has that reference.
object
Store description, or null.
The store’s domains.
object
The store’s subdomain on the platform domain, or null.
The store’s custom domain, or null.
Whether ownership of the custom domain is verified. Present only when the store was looked up by domain.
The store’s settings.
object
URL of the store’s logo, or null.
URL of the store’s favicon, or null.
Link to the store’s TikTok page, or null.
Link to the store’s Shopee page, or null.
Link to the store’s Facebook page, or null.
Link to the store’s Instagram page, or null.
The store’s Google Analytics measurement ID, or null.
The shop introduction from the published theme, or null.
URL of the store’s featured image, or null.
The store’s tagline, or null.
Title of the store’s blog.
Whether the blog is shown on the storefront.
Description of the store’s blog, or null.
Number of blog posts per page, or null.
Text placed before the order number, or null.
Text placed after the order number, or null.
Links to the store’s legal pages, or null.
object
Link to the terms of service: a site path or a URL.
Link to the privacy policy: a site path or a URL.
Whether visitors can comment on blog posts.
ISO 4217 code of the store’s currency.
The published theme.
object
ID of the published theme, or null when the store uses the default theme.
What the shoppers see: hosted (a theme release), custom (the store’s own code) or external (a link to another site).
Where the theme’s code runs: ecomweb or external.
For an external theme, the site the store redirects to; otherwise null.
The theme release in use, such as 1.0.0, or null for custom and external themes.
The theme’s setting values, keyed by setting name.
object
Theme name.
ID of the catalog theme the storefront renders.
The same theme data in the older layout, kept for storefronts built before themes. Prefer theme.
object
The theme’s primary color, or null.
References of the store’s main menus: main_menu, customer_support_menu and about_us_menu, each a string or null.
object
The top bar: message, a string or null.
object
The footer: copyright_text, a string or null.
object
The homepage: collection_slug, a string or null.
object
The checkout links: term_link and policy_link, each a string or null.
object
Scripts the merchant embedded in the storefront, such as analytics tags, ordered by name.
object
The store’s shop metafields that are visible to the storefront, keyed by namespace.key.
object
object
The metafield’s type, such as single_line_text_field or list.number_integer.
The store’s reference, used as storeRef in every other route.
Store name.
The store’s status; only active stores are returned.
When the store was created, as an ISO 8601 timestamp.
When the store was last updated, as an ISO 8601 timestamp.
Whether visitors see the coming soon page instead of the storefront. Such a store is only returned to a request that carries a preview token.
Example
{ "theme": { "kind": "hosted", "hosting": "ecomweb" }}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}