Skip to content

Get the store

GET
/public/stores/{ref}
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.

ref
required
string

The store’s reference.

include_config
boolean

Accepted for compatibility. The store’s domains are always returned.

include_settings
boolean

Accepted for compatibility. The store’s settings are always returned.

include_embedded_scripts
boolean

Accepted for compatibility. The store’s embedded scripts are always returned.

x-store-preview
required
string

The store, or an empty body when no store has that reference.

Media typeapplication/json
object
description
required

Store description, or null.

string
nullable
config

The store’s domains.

object
subdomain
required

The store’s subdomain on the platform domain, or null.

string
nullable
custom_domain
required

The store’s custom domain, or null.

string
nullable
verified

Whether ownership of the custom domain is verified. Present only when the store was looked up by domain.

boolean
settings

The store’s settings.

object
logo_url
required

URL of the store’s logo, or null.

string
nullable
favicon_url
required

URL of the store’s favicon, or null.

string
nullable
tiktok_link
required

Link to the store’s TikTok page, or null.

string
nullable
shopee_link
required

Link to the store’s Shopee page, or null.

string
nullable
facebook_link
required

Link to the store’s Facebook page, or null.

string
nullable
instagram_link
required

Link to the store’s Instagram page, or null.

string
nullable
google_analytics_key
required

The store’s Google Analytics measurement ID, or null.

string
nullable
shop_introduction
required

The shop introduction from the published theme, or null.

string
nullable
featured_image
required

URL of the store’s featured image, or null.

string
nullable
tagline
required

The store’s tagline, or null.

string
nullable
blog_title

Title of the store’s blog.

string
nullable
is_blog_enabled

Whether the blog is shown on the storefront.

boolean
nullable
blog_description
required

Description of the store’s blog, or null.

string
nullable
posts_per_page
required

Number of blog posts per page, or null.

number
nullable
order_number_prefix
required

Text placed before the order number, or null.

string
nullable
order_number_suffix
required

Text placed after the order number, or null.

string
nullable
legal_links
required

Links to the store’s legal pages, or null.

object
terms

Link to the terms of service: a site path or a URL.

string
nullable
privacy

Link to the privacy policy: a site path or a URL.

string
nullable
allow_comments
required

Whether visitors can comment on blog posts.

boolean
currency_code
required

ISO 4217 code of the store’s currency.

string
theme
required

The published theme.

object
id
required

ID of the published theme, or null when the store uses the default theme.

string
nullable
kind
required

What the shoppers see: hosted (a theme release), custom (the store’s own code) or external (a link to another site).

string
Allowed values: hosted custom external
hosting
required

Where the theme’s code runs: ecomweb or external.

string
Allowed values: ecomweb external
external_url
required

For an external theme, the site the store redirects to; otherwise null.

string
nullable
release_version
required

The theme release in use, such as 1.0.0, or null for custom and external themes.

string
nullable
values
required

The theme’s setting values, keyed by setting name.

object
key
additional properties
any
name
required

Theme name.

string
source_theme_id
required

ID of the catalog theme the storefront renders.

string
theme_config
required

The same theme data in the older layout, kept for storefronts built before themes. Prefer theme.

object
theme_color
required

The theme’s primary color, or null.

string
nullable
menu
required

References of the store’s main menus: main_menu, customer_support_menu and about_us_menu, each a string or null.

object
key
additional properties
string
nullable
topbar
required

The top bar: message, a string or null.

object
key
additional properties
string
nullable
footer
required

The footer: copyright_text, a string or null.

object
key
additional properties
string
nullable
homepage
required

The homepage: collection_slug, a string or null.

object
key
additional properties
string
nullable
checkout
required

The checkout links: term_link and policy_link, each a string or null.

object
key
additional properties
string
nullable
embedded_scripts
required

Scripts the merchant embedded in the storefront, such as analytics tags, ordered by name.

Array<object>
object
key
additional properties
any
metafields
required

The store’s shop metafields that are visible to the storefront, keyed by namespace.key.

object
key
additional properties
object
value
required

The value in the form its type defines. A reference type resolves to the referenced resource’s public data.

nullable
One of:
string
type
required

The metafield’s type, such as single_line_text_field or list.number_integer.

string
ref
required

The store’s reference, used as storeRef in every other route.

string
name
required

Store name.

string
status
required

The store’s status; only active stores are returned.

string
created_at
required

When the store was created, as an ISO 8601 timestamp.

string
updated_at
required

When the store was last updated, as an ISO 8601 timestamp.

string
coming_soon
required

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.

boolean

Example

{
"theme": {
"kind": "hosted",
"hosting": "ecomweb"
}
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}