---
title: "getPlannedEntries"
url: "https://developer-qual.migros.ch/apis/m-menuplan-api-1/versions/5dfaab2c-48a1-4941-bb45-522f1bb86d57/operations/getPlannedEntries"
---

> Full API specification: https://developer-qual.migros.ch/apis/m-menuplan-api-1/versions/5dfaab2c-48a1-4941-bb45-522f1bb86d57.md

# getPlannedEntries

`GET` `/migros/products/menuplan/v1/{tenant}/{subtenant}/PlannedEntries`

Operation ID: `getPlannedEntries`

Retrieve planned entries.

## Path parameters

- `tenant` (string, required)
- `subtenant` (string, required)

## Query parameters

- `DateFrom` (string, date-time, optional)
- `DateTo` (string, date-time, optional)
- `LineDefinitionId` (string, uuid, optional)
- `LineDefinitionIdentifier` (string, optional)
- `IsVisibleOnline` (boolean, optional)

## Responses

- `200` - OK

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: M-Menuplan API
  version: "1.0"
servers:
  - url: https://api-qual.migros.ch/
paths:
  /migros/products/menuplan/v1/{tenant}/{subtenant}/PlannedEntries:
    get:
      tags:
        - Plans
      description: Retrieve planned entries.
      operationId: getPlannedEntries
      parameters:
        - name: DateFrom
          in: query
          schema:
            type: string
            format: date-time
        - name: DateTo
          in: query
          schema:
            type: string
            format: date-time
        - name: LineDefinitionId
          in: query
          schema:
            type: string
            format: uuid
        - name: LineDefinitionIdentifier
          in: query
          schema:
            type: string
        - name: IsVisibleOnline
          in: query
          schema:
            type: boolean
        - name: tenant
          in: path
          required: true
          schema:
            type: string
        - name: subtenant
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.PlannedE\
                    ntryView"
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.PlannedE\
                    ntryView"
            text/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.PlannedE\
                    ntryView"
      security:
        - apiKeyAuth: []
security:
  - apiKeyAuth: []
components:
  schemas:
    Migros.MenuPlan.Service.Queries.ViewModels.PlannedEntryView:
      required:
        - date
        - id
        - offer
        - offerLine
        - plan
        - position
      type: object
      properties:
        id:
          type: string
          format: uuid
        date:
          type: string
          format: date-time
        position:
          type: integer
          format: int32
        offerLine:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.OfferLin\
            eOverviewView"
        offer:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.OfferOve\
            rviewPublicView"
        plan:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.PlanOver\
            viewView"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.OfferLineOverviewView:
      required:
        - id
        - lineDefinition
        - lineDefinitionId
        - nameTranslations
        - order
        - salesPrice
        - trayCount
      type: object
      properties:
        id:
          type: string
          format: uuid
        lineDefinitionId:
          type: string
          format: uuid
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        order:
          type: integer
          format: int32
        trayCount:
          type: integer
          format: int32
        salesPrice:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.Quantifi\
            edPriceView"
        lineDefinition:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.LineDefi\
            nitionView"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.OfferOverviewPublicView:
      required:
        - claims
        - id
        - nameTranslations
        - number
        - owner
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
          nullable: true
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        descriptionTranslations:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            nullable: true
          nullable: true
        type:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.PlanningType"
        status:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.OfferStatus"
        owner:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.Owner"
        salesPrice:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.Quantifi\
            edPriceView"
        claims:
          type: array
          items:
            $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.ClaimVie\
              w"
          nullable: true
        label:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.LabelVie\
            w"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.PlanOverviewView:
      required:
        - id
        - name
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.PlanningType"
        name:
          type: string
          nullable: true
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.QuantifiedPriceView:
      required:
        - quantity
        - value
      type: object
      properties:
        quantity:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.WeightVi\
            ew"
        value:
          type: number
          format: double
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.LineDefinitionView:
      required:
        - id
        - identifier
        - isActive
        - isVisibleOnline
        - nameTranslations
        - owner
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        identifier:
          type: string
          nullable: true
        type:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.PlanningType"
        owner:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.Owner"
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        isActive:
          type: boolean
        isVisibleOnline:
          type: boolean
      additionalProperties: false
    Migros.MenuPlan.Infrastructure.Enums.PlanningType:
      enum:
        - 1
        - 2
      type: integer
      format: int32
    Migros.MenuPlan.Infrastructure.Enums.OfferStatus:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      format: int32
    Migros.MenuPlan.Infrastructure.Enums.Owner:
      enum:
        - 1
        - 2
      type: integer
      format: int32
    Migros.MenuPlan.Service.Queries.ViewModels.ClaimView:
      required:
        - claimGroup
        - claimGroupId
        - id
        - isActive
        - nameTranslations
      type: object
      properties:
        id:
          type: string
          format: uuid
        claimGroupId:
          type: string
          format: uuid
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        isActive:
          type: boolean
        claimGroup:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.ClaimGro\
            upView"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.LabelView:
      required:
        - id
        - identifier
        - isActive
        - nameTranslations
      type: object
      properties:
        id:
          type: string
          format: uuid
        identifier:
          type: string
          nullable: true
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        isActive:
          type: boolean
        asset:
          $ref: "#/components/schemas/Migros.MenuPlan.Service.Queries.ViewModels.AssetVie\
            w"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.WeightView:
      required:
        - unit
        - value
      type: object
      properties:
        value:
          type: number
          format: double
        unit:
          $ref: "#/components/schemas/Migros.MRezept.Units.Unit"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.ClaimGroupView:
      required:
        - id
        - isActive
        - nameTranslations
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        nameTranslations:
          type: object
          additionalProperties:
            type: string
          nullable: true
        isActive:
          type: boolean
        type:
          $ref: "#/components/schemas/Migros.MenuPlan.Infrastructure.Enums.ClaimGroupType"
      additionalProperties: false
    Migros.MenuPlan.Service.Queries.ViewModels.AssetView:
      required:
        - contentLength
        - contentType
        - createdByGivenname
        - createdById
        - createdBySurname
        - fileName
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
        contentType:
          type: string
          nullable: true
        fileName:
          type: string
          nullable: true
        contentLength:
          type: integer
          format: int64
        createdById:
          type: string
          format: uuid
        createdByGivenname:
          type: string
          nullable: true
        createdBySurname:
          type: string
          nullable: true
      additionalProperties: false
    Migros.MRezept.Units.Unit:
      enum:
        - 0
        - 1
        - 2
        - 5
        - 6
        - 11
        - 12
        - 13
        - 14
        - 24
        - 34
        - 40
        - 50
        - 51
      type: integer
      format: int32
    Migros.MenuPlan.Infrastructure.Enums.ClaimGroupType:
      enum:
        - 1
      type: integer
      format: int32
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: api-key
      in: header
```