---
title: "SearchTeaserCollection"
url: "https://developer.migros.ch/apis/search-teasers-8/versions/cc87b2e6-ec15-45f0-8f1b-8017d8405a51/schemas/SearchTeaserCollection"
---

> Full API specification: https://developer.migros.ch/apis/search-teasers-8/versions/cc87b2e6-ec15-45f0-8f1b-8017d8405a51.md

# SearchTeaserCollection

A collection of search teaser instances.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Search Teasers
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api.migros.ch
components:
  schemas:
    AbstractSearchResultCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractCollection"
        - properties:
            ids:
              description: >-
                Ids only.


                Is filled instead of the usual property for content, with only
                the ids when a call is made with verbosity=id on a

                route that supports it.
              items:
                type: string
              type: array
            total_hits:
              description: >-
                The total hits may exceed the actual count of results in the
                collection.


                It represents the total number of results of a search and not
                only the

                potentially paginated subset.
              nullable: true
              type: integer
          type: object
      description: A collection of search result instances.
      type: object
    SearchTeaser:
      description: Represents a search teaser entry from the migros website.
      properties:
        active:
          type: boolean
        description:
          nullable: true
          type: string
        end:
          format: date-time
          nullable: true
          type: string
        id:
          description: The uuid.
          type: string
        image:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        keywords:
          nullable: true
          type: string
        language:
          type: string
        link:
          nullable: true
          type: string
        modification_date:
          format: date-time
          nullable: true
          type: string
        name:
          type: string
        parent_id:
          nullable: true
          type: string
        start:
          format: date-time
          nullable: true
          type: string
        title:
          nullable: true
          type: string
      required:
        - id
        - language
        - name
      type: object
    AbstractCollection:
      description: A generic collection of elements.
    Image:
      description: An image and its properties.
      properties:
        code:
          deprecated: true
          description: Code for the image, useful for pictograms.
          nullable: true
          type: string
        custom:
          deprecated: true
          description: Image URL with placeholders for {width} and {height}.
          type: string
        description:
          deprecated: true
          description: Image description, useful for example as alt attribute.
          nullable: true
          type: string
        end_date:
          deprecated: true
          description: End date of the validity.
          format: date-time
          nullable: true
          type: string
        hash:
          deprecated: true
          description: Sha1 hash of original image.
          nullable: true
          type: string
        original:
          deprecated: true
          description: Full size image.
          type: string
        source:
          deprecated: true
          description: Source where the image comes from originally.
          nullable: true
          type: string
        stack:
          deprecated: true
          description: Image URL with a placeholder for a Rokka {stack}.
          type: string
        start_date:
          deprecated: true
          description: Start date of the validity.
          format: date-time
          nullable: true
          type: string
        tags:
          deprecated: true
          items:
            type: string
          type: array
      type: object
    SearchTeaserCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractSearchResultCollection"
        - properties:
            teasers:
              items:
                $ref: "#/components/schemas/SearchTeaser"
              type: array
          type: object
      description: A collection of search teaser instances.
      required:
        - teasers
        - total_hits
      type: object
```