List homepage banners
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/banners';const options = {method: 'GET', headers: {'x-storefront-api-key': '<x-storefront-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/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.
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
object
Always null.
The link the banner points to, or null.
Always null.
Always true.
Always an empty object.
object
The banner slot, starting at 1.
The banner’s alt text, or an empty string when the theme sets none.
URL of the banner image.
The banner slot, starting at 1; banners are listed in this order.
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 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.
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"}