VTEX · Schema

Banners

Response body object.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
banners array List of banners.
View JSON Schema on GitHub

JSON Schema

vtex-banners-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Banners",
  "title": "Banners",
  "type": "object",
  "description": "Response body object.",
  "properties": {
    "banners": {
      "type": "array",
      "description": "List of banners.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Banner ID."
          },
          "name": {
            "type": "string",
            "description": "Banner name."
          },
          "area": {
            "type": "string",
            "description": "Banner area, which can be a number between 1 and 4, to be used in the store's [Banner](https://developers.vtex.com/docs/guides/vtex-search-banner) block."
          },
          "html": {
            "type": "string",
            "description": "Banner HTML, which can be an image or text."
          }
        }
      }
    }
  }
}