M-Menuplan API

M-Menuplan API

1.0OAS 3.0

An API to query the menu plans of restaurants that use the M-Menüplan application for their planning.

API Base URL
  • Server 1:https://api.migros.ch/
Security
apiKeyAuth (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called api-key.

Example: api-key: 123

Additional Information
Contact GMZ-IT Services und Lösungen (informatik@gmz.migros.ch)

getLineDefinitions

Retrieve a list of line definitions.

get
https://api.migros.ch/migros/products/menuplan/v1/{tenant}/{subtenant}/LineDefinitions

Query Parameters

SearchTermstring
Namestring
Identifierstring
Ownerinteger(int32)

Allowed values:12

Typeinteger(int32)

Allowed values:12

IsActiveboolean
IsVisibleOnlineboolean
Usage.Yearinteger(int32)required
Usage.IsoWeekinteger(int32)required
Usage.Ownerinteger(int32)required

Allowed values:12

OrderBystring
PageNumberinteger(int32)
PageSizeinteger(int32)

Path Parameters

tenantstringrequired
subtenantstringrequired

Response

OK

* Additional properties are NOT allowed.
idstring(uuid)required
identifierstring | nullrequired
typeinteger(int32)required

Allowed values:12

ownerinteger(int32)required

Allowed values:12

nameTranslationsobject | nullrequired
isActivebooleanrequired
isVisibleOnlinebooleanrequired
get/migros/products/menuplan/v1/{tenant}/{subtenant}/LineDefinitions
 

getLineDefinitionById

Get the line definition by id.

get
https://api.migros.ch/migros/products/menuplan/v1/{tenant}/{subtenant}/LineDefinitions/{lineDefinitionId}

Path Parameters

lineDefinitionIdstring(uuid)required
tenantstringrequired
subtenantstringrequired

Response

OK

Migros.MenuPlan.Service.Queries.ViewModels.LineDefinitionView

* Additional properties are NOT allowed.
idstring(uuid)required
identifierstring | nullrequired
typeinteger(int32)required

Allowed values:12

ownerinteger(int32)required

Allowed values:12

nameTranslationsobject | nullrequired
isActivebooleanrequired
isVisibleOnlinebooleanrequired
get/migros/products/menuplan/v1/{tenant}/{subtenant}/LineDefinitions/{lineDefinitionId}
 

getPlannedEntries

Retrieve planned entries.

get
https://api.migros.ch/migros/products/menuplan/v1/{tenant}/{subtenant}/PlannedEntries

Query Parameters

DateFromstring(date-time)
DateTostring(date-time)
LineDefinitionIdstring(uuid)
LineDefinitionIdentifierstring
IsVisibleOnlineboolean

Path Parameters

tenantstringrequired
subtenantstringrequired

Response

200

OK

* Additional properties are NOT allowed.
idstring(uuid)required
datestring(date-time)required
positioninteger(int32)required
offerLineobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
offerobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
planobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
get/migros/products/menuplan/v1/{tenant}/{subtenant}/PlannedEntries
 
200

Microsoft.AspNetCore.Mvc.ProblemDetails

object
typestring
titlestring
statusinteger(int32)
detailstring
instancestring
Example