Skip to main content
GET
/
apis
/
ecommerce-service
/
public
/
discovery
/
v2
/
banners
cURL
curl --request GET \
  --url https://{base-address}/apis/ecommerce-service/public/discovery/v2/banners
{
  "Status": "<string>",
  "Data": {
    "records": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "config": {
          "desktop": {
            "is_hidden": true,
            "type": "<string>",
            "image": {
              "banner_image": {
                "id": "<string>",
                "item": "<string>",
                "relative_path": "<string>",
                "file_meta_data": {
                  "name": "<string>",
                  "size": 123
                },
                "original_file_name": "<string>",
                "field_name": "<string>"
              },
              "title": "<string>",
              "max_height": 123,
              "alt_tag": "<string>",
              "redirect_url": "<string>",
              "is_open_in_new_tab": true
            },
            "html": {
              "content": "<string>",
              "max_height": 123
            },
            "video": {
              "url": "<string>",
              "iframe_attributes": "<string>",
              "max_height": 123,
              "max_width": 123
            },
            "onclick_event": "<string>",
            "onload_event": "<string>",
            "layout_attributes": {
              "id": "<string>",
              "layout_name": "<string>",
              "type": "<string>",
              "rows": 123,
              "columns": 123,
              "is_full_width": true,
              "layout_image": "<string>"
            }
          },
          "tablet": {
            "is_hidden": true,
            "is_desktop_override": true,
            "type": "<string>",
            "image": {
              "banner_image": {
                "id": "<string>",
                "item": "<string>",
                "relative_path": "<string>",
                "file_meta_data": {
                  "name": "<string>",
                  "size": 123
                },
                "original_file_name": "<string>",
                "field_name": "<string>"
              },
              "title": "<string>",
              "max_height": 123,
              "alt_tag": "<string>",
              "redirect_url": "<string>",
              "is_open_in_new_tab": true
            },
            "html": {
              "content": "<string>",
              "max_height": 123
            },
            "video": {
              "url": "<string>",
              "iframe_attributes": "<string>",
              "max_height": 123,
              "max_width": 123
            },
            "onclick_event": "<string>",
            "onload_event": "<string>",
            "layout_attributes": {
              "id": "<string>",
              "layout_name": "<string>",
              "type": "<string>",
              "rows": 123,
              "columns": 123,
              "is_full_width": true,
              "layout_image": "<string>"
            }
          },
          "mobile": {
            "is_hidden": true,
            "is_desktop_override": true,
            "type": "<string>",
            "image": {
              "banner_image": {
                "id": "<string>",
                "item": "<string>",
                "relative_path": "<string>",
                "file_meta_data": {
                  "name": "<string>",
                  "size": 123
                },
                "original_file_name": "<string>",
                "field_name": "<string>"
              },
              "title": "<string>",
              "max_height": 123,
              "alt_tag": "<string>",
              "redirect_url": "<string>",
              "is_open_in_new_tab": true
            },
            "html": {
              "content": "<string>",
              "max_height": 123
            },
            "video": {
              "url": "<string>",
              "iframe_attributes": "<string>",
              "max_height": 123,
              "max_width": 123
            },
            "onclick_event": "<string>",
            "onload_event": "<string>",
            "layout_attributes": {
              "id": "<string>",
              "layout_name": "<string>",
              "type": "<string>",
              "rows": 123,
              "columns": 123,
              "is_full_width": true,
              "layout_image": "<string>"
            }
          }
        },
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "_meta_": {
      "tenant_id": "<string>",
      "workspace_id": "<string>",
      "env_type": "<string>",
      "store_hash": "<string>",
      "total_count": 123
    }
  }
}
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.

Headers

​
x-ecomm-provider
string

E-commerce provider for contextualizing the API call (e.g., shopify, magento, etc.).

Query Parameters

​
banner_ids
string
required

Comma-separated list of specific banner IDs to retrieve

​
fields
string
required

Comma-separated list of fields to include in the response

​
locale
string
required

Specifies the language or region for the response data

​
limit
integer

Maximum number of items to return.

​
skip
integer

Number of items to skip for pagination offset.

​
sort_by
string

Field used to sort the results.

​
sort_order
string

Order in which to sort assets: asc (oldest first) or desc (newest first).

Response

Successfully retrieved banners.

​
Status
string

Indicates the overall request outcome.

​
Data
object