---
title: "LabelCollection"
url: "https://developer.migros.ch/apis/labels-8/versions/31f88c4b-e938-4af8-b6ee-855c0e1d3bd1/schemas/LabelCollection"
---

> Full API specification: https://developer.migros.ch/apis/labels-8/versions/31f88c4b-e938-4af8-b6ee-855c0e1d3bd1.md

# LabelCollection

A collection of label instances.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Labels
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api.migros.ch
components:
  schemas:
    Label:
      description: Represents the Label information in the Product.
      properties:
        description:
          description: The long description of the label (can contain HTML).
          nullable: true
          type: string
        id:
          description: ID of the label.
          type: string
        image:
          description: Image of the label.
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        links:
          additionalProperties:
            $ref: "#/components/schemas/Link"
          description: Collection of links indexed by string identifier.
          type: object
        name:
          description: Name of the label.
          type: string
        position_for_product_title:
          description: Indicates placement of the short name label in product title
          nullable: true
          type: string
        short_name_for_product_title:
          description: Shorter label variant of the product title
          nullable: true
          type: string
        slug:
          description: Unique user-friendly ID.
          type: string
      required:
        - id
        - name
        - slug
      type: object
    Image:
      description: An image and its properties.
      properties:
        original:
          description: Full size image.
          type: string
        stack:
          description: Image URL with a placeholder for a Rokka {stack}.
          type: string
      type: object
    Link:
      properties:
        url:
          description: URL to a third-party desktop page of the product.
          type: string
      type: object
    LabelCollection:
      description: A collection of label instances.
      properties:
        labels:
          items:
            $ref: "#/components/schemas/Label"
          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
      required:
        - labels
        - total_hits
      type: object
```