Skip to content

Get storefront code status

GET
/stores/{storeRef}/storefront/repo
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

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
github
required

The store’s GitHub connection.

object
account_login
required

The GitHub account the app is installed on, or null when not connected.

string
nullable
connected
required

Whether the store has an active GitHub connection.

boolean
repo
required

The store’s repository, or null when none was requested.

object
error
required

Why creating the repository failed, or null.

string
nullable
html_url
required

The repository’s web address on GitHub, or null until it exists.

string
nullable
full_name
required

The repository’s full name on GitHub, such as my-org/my-store-storefront, or null until it exists.

string
nullable
template_version
required

The version of the storefront template the repository was created from, or null.

string
nullable
store_theme_id
required

ID of the theme the repository’s code deploys to, or null.

string
nullable
created_at
required

When the request was made, as an ISO 8601 timestamp.

string format: date-time
status
required

How creating the repository is going: queued, running, ready or failed. A request that never finished shows as failed so you can try again.

string
enabled
required

Whether storefront code delivery is turned on.

boolean
site_url
required

The address of the store’s storefront, used as the site address in the code you download.

string

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.

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"
}