Get storefront code status
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/storefront/repo';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/example/storefront/repo \ --header 'x-api-key: <x-api-key>'Returns whether storefront code delivery is on, the store’s site address, the state of its GitHub connection and its storefront repository, if one was requested. Needs the admin:store scope; a key with only deploy:storefront cannot call it.
Required scopes: admin:store
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
The store’s GitHub connection.
object
The GitHub account the app is installed on, or null when not connected.
Whether the store has an active GitHub connection.
The store’s repository, or null when none was requested.
object
Why creating the repository failed, or null.
The repository’s web address on GitHub, or null until it exists.
The repository’s full name on GitHub, such as my-org/my-store-storefront, or null until it exists.
The version of the storefront template the repository was created from, or null.
ID of the theme the repository’s code deploys to, or null.
When the request was made, as an ISO 8601 timestamp.
How creating the repository is going: queued, running, ready or failed. A request
that never finished shows as failed so you can try again.
Whether storefront code delivery is turned on.
The address of the store’s storefront, used as the site address in the code you download.
Example generated
{ "github": { "account_login": "example", "connected": true }, "repo": { "error": "example", "html_url": "example", "full_name": "example", "template_version": "example", "store_theme_id": "example", "created_at": "2026-04-15T12:00:00Z", "status": "example" }, "enabled": true, "site_url": "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"}