List stores
const url = 'https://apibase.ecomweb.app/api/v1/stores?limit=20&offset=0&status=pending&subdomain=my-store&custom_domain=mystore.com&sort_by=id&include_config=false&include_settings=false&include_subscription=false';const options = {method: 'GET', headers: {'x-api-key': '<x-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/stores?limit=20&offset=0&status=pending&subdomain=my-store&custom_domain=mystore.com&sort_by=id&include_config=false&include_settings=false&include_subscription=false' \ --header 'x-api-key: <x-api-key>'Returns the stores the key can see, in pages (limit up to the maximum page size, offset). A secret key belongs to one store, so it lists only that store. Filter by status, subdomain or custom_domain, and sort with sort_by. Set include_settings, include_config or include_subscription to add the store’s settings, domain configuration or plan to each store.
Required scopes: none. Any secret key for this store works.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Example
20Number of items per page
Example
0Number of items to skip
Example
activeFilter by store status
Example
my-storeFilter by subdomain (exact match)
Example
mystore.comFilter by custom domain (exact match)
Example
created_atSort field
Example
trueInclude store config
Example
trueInclude store settings
Example
trueInclude each store’s subscription summary (status and plan name)
Responses
Section titled “Responses”object
The stores on this page.
object
Store description, or null.
pending while the store is being set up, active, or disabled by the merchant.
Progress flags of the store’s setup, such as product_added and theme_customized.
object
Deletion time as an ISO 8601 timestamp, or null. Deleted stores are not returned, so this is normally null.
When the store was first opened to the public, as an ISO 8601 timestamp. Null until then.
When the merchant ended setup without opening the store, as an ISO 8601 timestamp, or null.
The store’s settings. Present only when include_settings is set; null when the store has none yet.
object
Logo URL, or null.
TikTok profile link, or null.
Shopee store link, or null.
Google Analytics tracking key, or null.
Facebook page link, or null.
Instagram profile link, or null.
Favicon URL, or null.
Featured image URL, or null.
Store tagline, or null.
Three-letter currency code of the store, such as VND.
Which roles receive which notification emails. A free-form object, or null.
object
Whether customers are asked for a product review after their order.
Sender name shown on the store’s emails, or null for the default.
Reply-to address of the store’s emails, or null.
Whether the platform bill PDF is attached to billing emails.
Text placed before the order number in order codes, such as DH-. Null for none.
Text placed after the order number in order codes, such as -26. Null for none.
Accent colour of email buttons and links as #RRGGBB, or null for the default.
Email canvas background colour as #RRGGBB, or null for the default.
Email content background colour as #RRGGBB, or null for the default.
Email text colour as #RRGGBB, or null for the default.
Email footer text colour as #RRGGBB, or null for the default.
Logo shown in email headers, or null to use logo_url.
Short line under the logo in email headers, or null.
Postal address in the email footer, or null.
Phone number in the email footer, or null.
ID of the store’s live theme, or null when none is published.
Checkout and register links, 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.
When the settings were created, as an ISO 8601 timestamp.
When the settings were last updated, as an ISO 8601 timestamp.
The store’s domain configuration. Present only when include_config is set; null when it has none yet.
object
The store’s subdomain on the platform domain, or null.
The store’s custom domain in lower case, or null.
Whether the custom domain is verified. It serves the store only when it is.
The value the merchant publishes in DNS to prove they own the custom domain. Put it in
a TXT record named _ecomweb-verify.<domain> as ecomweb-verify=<token>. Null until a
custom domain is claimed.
When the current custom domain was claimed, as an ISO 8601 timestamp, or null.
When a verified domain’s DNS record was last re-checked, as an ISO 8601 timestamp, or null.
Set while a verified domain’s DNS record is missing: the domain is released at this time. Null otherwise.
When the configuration was created, as an ISO 8601 timestamp.
When the configuration was last updated, as an ISO 8601 timestamp.
The store’s plan. Present only on the list and only when include_subscription is set.
object
Name of the plan, or null.
When the trial ends, as an ISO 8601 timestamp, or null.
When the current billing period ends, as an ISO 8601 timestamp, or null.
Subscription status, such as active.
True for the free plan. A free store still has an active subscription.
True on the trial plan every new store starts on.
The caller’s role in the store, such as owner. Present only on the list.
The store’s reference, used as storeRef in every other route.
ID of the account that owns the store.
Store name.
Whether the store has already used its free trial.
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.
Whether the setup guide is hidden in the dashboard.
Paging details.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
Example
{ "data": [ { "status": "pending" } ]}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"}