Skip to content

List homepage banners

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

Deprecated: banners are now settings of the published theme, so read them from the theme.values of the store instead. This route lists the banner images set in the published theme, in slot order, in the same envelope as a paged list. It always returns every banner on one page.

storeRef
required
string

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

Media typeapplication/json
object
data
required
Array<object>
object
subtitle
required

Always null.

string
nullable
link_url
required

The link the banner points to, or null.

string
nullable
button_text
required

Always null.

string
nullable
is_active
required

Always true.

boolean
metadata
required

Always an empty object.

object
key
additional properties
any
id
required

The banner slot, starting at 1.

number
title
required

The banner’s alt text, or an empty string when the theme sets none.

string
image_url
required

URL of the banner image.

string
position
required

The banner slot, starting at 1; banners are listed in this order.

number
meta
required
object
total
required

Total number of items matching the request.

number
limit
required

Maximum number of items in this page.

number
offset
required

Number of items skipped before this page.

number
page
required

Current page number, starting at 1.

number
totalPages
required

Total number of pages.

number
hasNext
required

Whether a next page exists.

boolean
hasPrev
required

Whether a previous page exists.

boolean

Example generated

{
"data": [
{
"subtitle": "example",
"link_url": "example",
"button_text": "example",
"is_active": true,
"metadata": {},
"id": 1,
"title": "example",
"image_url": "example",
"position": 1
}
],
"meta": {
"total": 1,
"limit": 1,
"offset": 1,
"page": 1,
"totalPages": 1,
"hasNext": true,
"hasPrev": true
}
}

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