Skip to content

Download the storefront template

GET
/stores/{storeRef}/storefront/template/download
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/storefront/template/download \
--header 'x-api-key: <x-api-key>'

Downloads the latest storefront template as a zip archive, named storefront-template-<version>.zip. Check it against the SHA-256 from the template route. Returns a 404 when storefront code delivery is off or no template was published. Needs the admin:store scope.

Required scopes: admin:store

storeRef
required
string

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

The template as a zip archive.

Media typeapplication/zip
string format: binary

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