> ## Documentation Index
> Fetch the complete documentation index at: https://help.experro.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Banners By Ids

> Fetch banners for display in the eCommerce interface. Supports field selection and filtering to retrieve relevant banner content.

Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See [Authentication & Base URLs](/api-reference/authbaseurl).


## OpenAPI

````yaml GET /apis/ecommerce-service/public/discovery/v2/banners
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://apis.experro.app
    description: Admin Server
  - url: https://{base-address}
    description: Custom Server
    variables:
      base-address:
        default: ''
        description: Enter your custom domain or server address.
security:
  - bearerAuth: []
paths:
  /apis/ecommerce-service/public/discovery/v2/banners:
    get:
      description: >-
        Fetch banners for display in the eCommerce interface. Supports field
        selection and filtering to retrieve relevant banner content.
      parameters:
        - $ref: '#/components/parameters/EcommProviderHeader'
        - name: banner_ids
          in: query
          description: Comma-separated list of specific banner IDs to retrieve
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/FieldsQryPrm'
        - $ref: '#/components/parameters/LocaleQryPrm'
        - $ref: '#/components/parameters/LimitQryPrm'
        - $ref: '#/components/parameters/SkipQryPrm'
        - name: sort_by
          in: query
          schema:
            type: string
          description: Field used to sort the results.
        - name: sort_order
          in: query
          schema:
            type: string
          description: >-
            Order in which to sort assets: `asc` (oldest first) or `desc`
            (newest first).
      responses:
        '200':
          description: Successfully retrieved banners.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    description: Indicates the overall request outcome.
                  Data:
                    type: object
                    properties:
                      records:
                        type: array
                        description: Array of banner record objects.
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique identifier of the banner.
                            name:
                              type: string
                              description: Name of the banner.
                            description:
                              type: string
                              nullable: true
                              description: Description of the banner.
                            config:
                              type: object
                              description: Banner configuration for different device types.
                              properties:
                                desktop:
                                  type: object
                                  properties:
                                    is_hidden:
                                      type: boolean
                                    type:
                                      type: string
                                    image:
                                      type: object
                                      properties:
                                        banner_image:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                            item:
                                              type: string
                                            relative_path:
                                              type: string
                                            file_meta_data:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                size:
                                                  type: integer
                                            original_file_name:
                                              type: string
                                            field_name:
                                              type: string
                                        title:
                                          type: string
                                        max_height:
                                          type: integer
                                        alt_tag:
                                          type: string
                                        redirect_url:
                                          type: string
                                        is_open_in_new_tab:
                                          type: boolean
                                    html:
                                      type: object
                                      properties:
                                        content:
                                          type: string
                                        max_height:
                                          type: integer
                                          nullable: true
                                    video:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                        iframe_attributes:
                                          type: string
                                        max_height:
                                          type: integer
                                          nullable: true
                                        max_width:
                                          type: integer
                                          nullable: true
                                    onclick_event:
                                      type: string
                                    onload_event:
                                      type: string
                                    layout_attributes:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                        layout_name:
                                          type: string
                                        type:
                                          type: string
                                        rows:
                                          type: integer
                                        columns:
                                          type: integer
                                        is_full_width:
                                          type: boolean
                                        layout_image:
                                          type: string
                                tablet:
                                  type: object
                                  properties:
                                    is_hidden:
                                      type: boolean
                                    is_desktop_override:
                                      type: boolean
                                    type:
                                      type: string
                                    image:
                                      type: object
                                      properties:
                                        banner_image:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                            item:
                                              type: string
                                            relative_path:
                                              type: string
                                            file_meta_data:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                size:
                                                  type: integer
                                            original_file_name:
                                              type: string
                                            field_name:
                                              type: string
                                        title:
                                          type: string
                                        max_height:
                                          type: integer
                                        alt_tag:
                                          type: string
                                        redirect_url:
                                          type: string
                                        is_open_in_new_tab:
                                          type: boolean
                                    html:
                                      type: object
                                      properties:
                                        content:
                                          type: string
                                        max_height:
                                          type: integer
                                          nullable: true
                                    video:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                        iframe_attributes:
                                          type: string
                                        max_height:
                                          type: integer
                                          nullable: true
                                        max_width:
                                          type: integer
                                          nullable: true
                                    onclick_event:
                                      type: string
                                    onload_event:
                                      type: string
                                    layout_attributes:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                        layout_name:
                                          type: string
                                        type:
                                          type: string
                                        rows:
                                          type: integer
                                        columns:
                                          type: integer
                                        is_full_width:
                                          type: boolean
                                        layout_image:
                                          type: string
                                mobile:
                                  type: object
                                  properties:
                                    is_hidden:
                                      type: boolean
                                    is_desktop_override:
                                      type: boolean
                                    type:
                                      type: string
                                    image:
                                      type: object
                                      properties:
                                        banner_image:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                            item:
                                              type: string
                                            relative_path:
                                              type: string
                                            file_meta_data:
                                              type: object
                                              properties:
                                                name:
                                                  type: string
                                                size:
                                                  type: integer
                                            original_file_name:
                                              type: string
                                            field_name:
                                              type: string
                                        title:
                                          type: string
                                        max_height:
                                          type: integer
                                        alt_tag:
                                          type: string
                                        redirect_url:
                                          type: string
                                        is_open_in_new_tab:
                                          type: boolean
                                    html:
                                      type: object
                                      properties:
                                        content:
                                          type: string
                                        max_height:
                                          type: integer
                                          nullable: true
                                    video:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                        iframe_attributes:
                                          type: string
                                        max_height:
                                          type: integer
                                          nullable: true
                                        max_width:
                                          type: integer
                                          nullable: true
                                    onclick_event:
                                      type: string
                                    onload_event:
                                      type: string
                                    layout_attributes:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                        layout_name:
                                          type: string
                                        type:
                                          type: string
                                        rows:
                                          type: integer
                                        columns:
                                          type: integer
                                        is_full_width:
                                          type: boolean
                                        layout_image:
                                          type: string
                            created_at:
                              type: string
                              format: date-time
                              description: Banner creation timestamp.
                            modified_at:
                              type: string
                              format: date-time
                              description: Banner last modification timestamp.
                      _meta_:
                        type: object
                        description: Metadata about the request and response.
                        properties:
                          tenant_id:
                            type: string
                            description: Tenant identifier.
                          workspace_id:
                            type: string
                            description: Workspace identifier.
                          env_type:
                            type: string
                            description: Environment type.
                          store_hash:
                            type: string
                            description: Store hash identifier.
                          total_count:
                            type: integer
                            description: Total number of banners available.
        '400':
          description: Bad Request – invalid parameters or query syntax.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    example: failure
                  Data:
                    $ref: '#/components/schemas/Error404'
        '401':
          description: Unauthorized – Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    example: failure
                  Data:
                    $ref: '#/components/schemas/Error401'
        '500':
          description: Internal Server Error – an unexpected error on the server.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    example: failure
                  Data:
                    $ref: '#/components/schemas/Error500'
      security: []
      servers:
        - url: https://{base-address}
          description: Custom Server
          variables:
            base-address:
              default: ''
              description: Enter your custom domain or server address.
components:
  parameters:
    EcommProviderHeader:
      name: x-ecomm-provider
      in: header
      required: false
      schema:
        type: string
      description: >-
        eCommerce provider for contextualizing the API call (e.g., shopify,
        magento, etc.).
    FieldsQryPrm:
      name: fields
      in: query
      description: Comma-separated list of fields to include in the response
      schema:
        type: string
      required: true
    LocaleQryPrm:
      name: locale
      in: query
      description: Specifies the language or region for the response data
      required: true
      schema:
        type: string
    LimitQryPrm:
      name: limit
      in: query
      schema:
        type: integer
      description: Maximum number of items to return.
    SkipQryPrm:
      name: skip
      in: query
      schema:
        type: integer
      description: Number of items to skip for pagination offset.
  schemas:
    Error404:
      type: object
      properties:
        Status:
          type: string
          example: failure
        Error:
          type: object
          properties:
            message:
              type: string
            name:
              type: string
            code:
              type: string
          required:
            - message
            - name
      required:
        - Status
        - Error
    Error401:
      type: object
      properties:
        Status:
          type: string
          example: failure
        Error:
          type: object
          properties:
            message:
              type: string
            name:
              type: string
            code:
              type: string
          required:
            - message
            - name
      required:
        - Status
        - Error
    Error500:
      type: object
      properties:
        Status:
          type: string
          example: failure
        Error:
          type: object
          properties:
            message:
              type: string
            name:
              type: string
            code:
              type: string
          required:
            - message
            - name
      required:
        - Status
        - Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````