---
title: "DiscountedPrice"
url: "https://developer-qual.migros.ch/apis/products-related-8/versions/051741b6-0319-4b5e-b1f1-6bdbc778acb6/schemas/DiscountedPrice"
---

> Full API specification: https://developer-qual.migros.ch/apis/products-related-8/versions/051741b6-0319-4b5e-b1f1-6bdbc778acb6.md

# DiscountedPrice

Represents a discounted price in the Product.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Products Related
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api-qual.migros.ch
components:
  schemas:
    BasePrice:
      description: |-
        Represents a price basic information in the Product.

        This is not used for the base price property.
      properties:
        currency:
          nullable: true
          type: string
        estimated_piece_price:
          description: >-
            The estimated price of a piece.


            Some products that are usually sold by weight (fruit, vegetables,
            meat). But aMigos

            needs to know the estimated price based on the average weight of one
            piece as it

            is added to the cart by number and not by weight.
          format: float
          nullable: true
          type: number
        estimated_piece_weight:
          description: |-
            The estimated weight of a piece (in grams).

            The average weight that the estimated piece price is calculated on.
          format: float
          nullable: true
          type: number
        item:
          description: The items price, quantity and unit.
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/PriceQuantityUnit"
        no_price_hint:
          description: The price hint if no price is set.
          nullable: true
          type: string
        source:
          nullable: true
          type: string
        valid_from:
          format: date
          type: string
        valid_to:
          format: date
          type: string
      required:
        - valid_from
        - valid_to
      type: object
    PriceQuantityUnit:
      description: Represents the current price and quantity (within a region).
      properties:
        display_quantity:
          description: The quantity and unit to display in the frontend.
          nullable: true
          type: string
        original_price:
          description: The original price value if price is the discounted value.
          format: float
          nullable: true
          type: number
        price:
          description: The price value.
          format: float
          nullable: true
          type: number
        quantity:
          description: The quantity the price is based on.
          format: float
          nullable: true
          type: number
        unit:
          description: The price unit.
          nullable: true
          type: string
        varying_quantity:
          description: Whether the quantity is flexible or fixed.
          nullable: true
          type: boolean
      type: object
    BaseDiscount:
      description: Represents the Discount information.
      properties:
        additional_description:
          description: |-
            Description text for a discount

            E.g.
            Zucht aus Dänemark
          nullable: true
          type: string
        additional_text:
          description: Additional information about the discount, e.g. 'in Selbstbedienung
            und Bedienung'
          nullable: true
          type: string
        advertisement_type_id:
          description: >-
            ID of how to advertise this discount.


            An example usage is to distinguish if the price or the percentage
            should be promoted more.
          nullable: true
          type: string
        badge:
          description: >-
            The currently active badge.


            This field is only available when using the Discount model to
            consume MAPI data.
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Badge"
        boss_number:
          description: The BoSS number.
          nullable: true
          type: string
        campaign_ids:
          description: >-
            List of campaign ID's this discount is in.


            These campaign ID's are delivered by the M-Promo system, used for
            promotions.
          items:
            type: string
          nullable: true
          type: array
        channel:
          nullable: true
          type: string
        collective_discount:
          description: Collective discount (Sammelaktion).
          type: boolean
        conditions:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/DiscountConditions"
        cooperative:
          description: Cooperative which created this discount. "Erfassergruppe"
          nullable: true
          type: string
        cumulus_points:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/DiscountCumulusPoints"
        description:
          description: May contain HTML tags.
          nullable: true
          type: string
        disclaimer:
          nullable: true
          type: string
        discount_amount:
          nullable: true
          type: string
        discount_events:
          description: |-
            List of events this discount is in.

            These events are created in the M-Promo system, used for promotions.
          items:
            $ref: "#/components/schemas/DiscountEvent"
          nullable: true
          type: array
        discount_hint:
          description: May contain HTML tags.
          nullable: true
          type: string
        discount_regions:
          description: List of regions in which the discount is valid in.
          items:
            type: string
          type: array
        discount_role_id:
          description: Discount role id.
          nullable: true
          type: string
        discount_role_label:
          description: Discount role label.
          nullable: true
          type: string
        discount_type:
          description: |-
            Discount type: "neuheit" or "aktion".

            See DISCOUNT_* constants.
          enum:
            - neuheit
            - aktion
          type: string
        discount_type_id:
          description: Discount type id.
          nullable: true
          type: string
        discount_type_label:
          description: Label for discount type id.
          nullable: true
          type: string
        end_date:
          format: date-time
          nullable: true
          type: string
        example_text:
          description: >-
            Information text about an example product of a discount for multiple
            products.


            Examples include

            M-Classic, Wildfang aus dem Nordostatlantik
          nullable: true
          type: string
        example_unit:
          description: >-
            Information about the unit of the package of an example product of a
            discount for multiple products.


            The 'unit' (see field above) is used for discounts for one specific
            product.

            The 'exampleUnit' is used for discounts for multiple products.

            Only one of the two fields contains a value.


            Examples include:

            200 g

            16 Stück, 216 g

            12 x 50 g
          nullable: true
          type: string
        high_performer:
          description: High performing discount.
          type: boolean
        id:
          description: Pex discounts do not have an id, so this field has to be optional.
          nullable: true
          type: string
        image:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        image_transparent:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        instead_of:
          nullable: true
          type: string
        last_imported:
          description: Time of last import.
          format: date-time
          nullable: true
          type: string
        last_mapped:
          description: Time of last mapping to Elasticsearch.
          format: date-time
          nullable: true
          type: string
        location_planning_type:
          description: Location planning type. "Planungsart" on M-Promo. Usually either
            "national" or "regional" or "lokal".
          nullable: true
          type: string
        logo:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        newsletter_image:
          nullable: true
          type: string
        organisation:
          description: smvm, fm...
          nullable: true
          type: string
        original_price:
          description: The original price.
          format: float
          nullable: true
          type: number
        package_description:
          description: |-
            Information about the package.

            Examples include:
            4er-Pack
            Im Duo-Pack
            Im 12er-Pack
          nullable: true
          type: string
        price:
          description: The discounted price.
          format: float
          nullable: true
          type: number
        profit:
          nullable: true
          type: integer
        publication_date:
          description: Publication date of the discount.
          format: date-time
          nullable: true
          type: string
        reduction:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/DiscountReduction"
        reduction_type_id:
          description: |-
            The reduction type id of the discount.

            01 - "Relativer Rabatt"
            02 - "Absoluter Rabatt"
            03 - "X für Y"
            04 - "Absolute CUMULUS Punkte"
            05 - "X-Fach Punkte"
            06 - "Rabattpreis = CHF"
            07 - "HIT"
            08 - "Preisabschlag"
          nullable: true
          type: string
        reference_product_id:
          description: ID of the reference product of this discount.
          nullable: true
          type: string
        region:
          description: |-
            The region (Migros Genossenschaft).

            See regions in RegionalInformation.
          nullable: true
          type: string
        secondary_image:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        secondary_logo:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        source:
          type: string
        special_advertisement:
          description: Whether or not it's a "Zusatzauslobung".
          type: boolean
        start_date:
          format: date-time
          nullable: true
          type: string
        tags:
          description: Tags for flagging certain discounts.
          items:
            type: string
          nullable: true
          type: array
        unit:
          description: |-
            Information about the unit of the sold package.

            Examples include:
            Mödeli, 4 x 250 g
            per 100 g, in Selbstbedienung
          nullable: true
          type: string
        visibility:
          description: Whether the discount visibility is overridden, can be 'blacklist'
            or 'whitelist'.
          nullable: true
          type: string
      required:
        - id
        - last_mapped
      type: object
    Badge:
      allOf:
        - $ref: "#/components/schemas/AbstractBadge"
        - properties:
            description:
              nullable: true
              type: string
            signet:
              description: An optional signet for the badge (used for "Neuheiten").
              nullable: true
              oneOf:
                - $ref: "#/components/schemas/BadgeSignet"
          type: object
      description: A badge image and its properties.
      type: object
    DiscountConditions:
      properties:
        minimum_pieces:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/DiscountConditionsMinimumPieces"
        minimum_purchase_price:
          example: 10
          format: float
          nullable: true
          type: number
      type: object
    DiscountCumulusPoints:
      properties:
        relative:
          example: true
          type: boolean
        value:
          example: 20
          type: integer
      required:
        - value
        - relative
      type: object
    DiscountEvent:
      description: >-
        Represents a discount event on a discount. These events are created in
        the M-Promo system, used for promotions.


        product_ids are only available on stand alone discount events, if there
        are any specified.


        discount_id and campaign_id are only set on stand alone discount events.
        When it is nested inside a discount,

        refer to the containing object to find the id and campaign ids.
      properties:
        advertising_material_id:
          description: The id of the advertising material. "Werbemittel".
          nullable: true
          type: string
        advertising_material_type_id:
          description: The id of the advertising material type. "Werbemittelart".
          nullable: true
          type: string
        campaign_ids:
          description: Campaigns of the discount that contains this event.
          items:
            type: string
          nullable: true
          type: array
        discount_id:
          description: The id of the discount this event is part of.
          nullable: true
          type: string
        end_date:
          description: When the event ends.
          format: date-time
          type: string
        event_id:
          description: The id of the event.
          type: string
        product_ids:
          description: List of product ids this event applies to.
          items:
            type: string
          nullable: true
          type: array
        publication_date:
          description: >-
            When the event was published online.


            The API does not output events when the publication date is in the
            future.
          format: date-time
          type: string
        start_date:
          description: When the event starts.
          format: date-time
          type: string
      required:
        - event_id
        - advertising_material_type_id
        - advertising_material_id
        - start_date
        - end_date
        - publication_date
      type: object
    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
    DiscountReduction:
      properties:
        amount:
          example: 32.5
          format: float
          type: number
        relative:
          example: true
          type: boolean
        suffix:
          example: günstiger
          nullable: true
          type: string
        unit:
          example: "%"
          nullable: true
          type: string
      required:
        - amount
        - relative
      type: object
    AbstractBadge:
      properties:
        custom:
          description: Image URL with placeholders for {width} and {height}.
          type: string
        hex_color:
          description: The hexadecimal color code for this badge.
          nullable: true
          type: string
        original:
          description: Full size image.
          type: string
        stack:
          description: Image URL with a placeholder for a Rokka {stack}.
          type: string
        vector:
          description: Vector image.
          type: string
      type: object
    BadgeSignet:
      allOf:
        - $ref: "#/components/schemas/AbstractBadge"
      description: A badge signet and its properties.
    DiscountConditionsMinimumPieces:
      properties:
        prefix:
          example: ab
          type: string
        value:
          example: 2
          type: integer
      required:
        - value
        - prefix
      type: object
    DiscountedPrice:
      allOf:
        - $ref: "#/components/schemas/BasePrice"
        - properties:
            base:
              description: The base price, quantity and unit.
              nullable: true
              oneOf:
                - $ref: "#/components/schemas/PriceQuantityUnit"
            discount:
              description: The discount for this price.
              nullable: true
              oneOf:
                - $ref: "#/components/schemas/BaseDiscount"
            discount_hint:
              nullable: true
              type: string
            estimated_piece_original_price:
              description: The estimated original price of a piece, without discount.
              format: float
              nullable: true
              type: number
          type: object
      description: Represents a discounted price in the Product.
      type: object
```