MenuApi (1.0.0)

Download OpenAPI specification:

The OktoPOS Manager MenuAPI provides a way to get menus, menu articles, and the status of menu articles for third party applications. It is specifically useful to export menus and articles for external shop systems from the OktoPOS Manager.

Authentication

All functions in this API require a valid authentication token. You can find this token in your instance of OktoPOS Manager in OktoPOS -> System.

Preconditions

The OktoPOS Manager can only process orders with known articles identified by its ID. Also distribution channels and tax rates need to be identifiable. These information are available in the Article-Api. See article/openapi.yaml.

menus

get a menu article by its identifier

Authorizations:

api_key

path Parameters

identifier

required

integer

Responses

Response samples

Content type

application/json

[{"basicArticle": {"id": 0,
"externalReferenceNumber": "string",
"description": "string",
"price": [{"distributionChannel": {"id": 0,
"token": "INHOUSE"
},
"price": "1.10",
"articleTax": {"taxRateValue": 16,
"taxRateCode": "A",
"taxRateId": 3
},
"priceForUnit": {"unit": "ml",
"quantity": "100",
"price": "1.30"
}
}
],
"cashierCanChangePrice": false,
"unit": {"id": 0,
"token": "kg"
},
"group": {"token": "Hauptgerichte"
},
"materialNumber": "string"
},
"names": [{"languageCode": "string",
"value": "string"
}
],
"basicDescription": [{"languageCode": "string",
"value": "string"
}
],
"detailedDescription": [{"languageCode": "string",
"value": "string"
}
],
"menuSubtitle": [{"languageCode": "string",
"value": "string"
}
],
"images": [{"type": "string",
"url": "string"
}
],
"allergens": [{"id": 0,
"token": "string",
"type": {"id": 0,
"value": "string"
}
}
],
"nutritionFacts": [{"type": {"id": 1,
"token": "Fat",
"unit": {"id": 0,
"token": "kg"
},
"unitAbbreviation": "g"
},
"baseUnit": {"unit": {"id": 0,
"token": "kg"
},
"unitAbbreviation": "mg",
"value": 2000,
"baseValue": 0.1234
},
"relativeUnit": {"unit": {"id": 0,
"token": "kg"
},
"unitAbbreviation": "g",
"displayFactor": 100,
"value": 0.0025
}
}
],
"sideOrderGroups": [{"name": "string",
"position": 0,
"type": "STANDARD",
"minSelectableArticles": 0,
"maxSelectableArticles": 0,
"maxPerArticle": 0,
"sideOrders": [{"basicArticle": {"id": 0,
"externalReferenceNumber": "string",
"description": "string",
"price": [{"distributionChannel": {"id": null,
"token": null
},
"price": "1.10",
"articleTax": {"taxRateValue": null,
"taxRateCode": null,
"taxRateId": null
},
"priceForUnit": {"unit": null,
"quantity": null,
"price": null
}
}
],
"cashierCanChangePrice": false,
"unit": {"id": 0,
"token": "kg"
},
"group": {"token": "Hauptgerichte"
},
"materialNumber": "string"
},
"names": [{"languageCode": "string",
"value": "string"
}
],
"basicDescription": [{"languageCode": "string",
"value": "string"
}
],
"detailedDescription": [{"languageCode": "string",
"value": "string"
}
],
"menuSubtitle": [{"languageCode": "string",
"value": "string"
}
],
"images": [{"type": "string",
"url": "string"
}
],
"allergens": [{"id": 0,
"token": "string",
"type": {"id": 0,
"value": "string"
}
}
],
"nutritionFacts": [{"type": {"id": 1,
"token": "Fat",
"unit": {"id": null,
"token": null
},
"unitAbbreviation": "g"
},
"baseUnit": {"unit": {"id": null,
"token": null
},
"unitAbbreviation": "mg",
"value": 2000,
"baseValue": 0.1234
},
"relativeUnit": {"unit": {"id": null,
"token": null
},
"unitAbbreviation": "g",
"displayFactor": 100,
"value": 0.0025
}
}
],
"priceType": "string",
"position": 0,
"preparationMethods": [{"id": 1,
"name": "cold",
"position": 1
}
],
"type": "string"
}
]
}
],
"preparationMethods": [{"id": 1,
"name": "cold",
"position": 1
}
],
"poolingArticles": [{"basicArticle": {"id": 0,
"externalReferenceNumber": "string",
"description": "string",
"price": [{"distributionChannel": {"id": 0,
"token": "INHOUSE"
},
"price": "1.10",
"articleTax": {"taxRateValue": 16,
"taxRateCode": "A",
"taxRateId": 3
},
"priceForUnit": {"unit": "ml",
"quantity": "100",
"price": "1.30"
}
}
],
"cashierCanChangePrice": false,
"unit": {"id": 0,
"token": "kg"
},
"group": {"token": "Hauptgerichte"
},
"materialNumber": "string"
},
"names": [{"languageCode": "string",
"value": "string"
}
],
"basicDescription": [{"languageCode": "string",
"value": "string"
}
],
"detailedDescription": [{"languageCode": "string",
"value": "string"
}
],
"menuSubtitle": [{"languageCode": "string",
"value": "string"
}
],
"images": [{"type": "string",
"url": "string"
}
],
"allergens": [{"id": 0,
"token": "string",
"type": {"id": 0,
"value": "string"
}
}
],
"nutritionFacts": [{"type": {"id": 1,
"token": "Fat",
"unit": {"id": 0,
"token": "kg"
},
"unitAbbreviation": "g"
},
"baseUnit": {"unit": {"id": 0,
"token": "kg"
},
"unitAbbreviation": "mg",
"value": 2000,
"baseValue": 0.1234
},
"relativeUnit": {"unit": {"id": 0,
"token": "kg"
},
"unitAbbreviation": "g",
"displayFactor": 100,
"value": 0.0025
}
}
],
"sideOrderGroups": [{"name": "string",
"position": 0,
"type": "STANDARD",
"minSelectableArticles": 0,
"maxSelectableArticles": 0,
"maxPerArticle": 0,
"sideOrders": [{"basicArticle": {"id": 0,
"externalReferenceNumber": "string",
"description": "string",
"price": [null
],
"cashierCanChangePrice": false,
"unit": {"id": null,
"token": null
},
"group": {"token": null
},
"materialNumber": "string"
},
"names": [{"languageCode": null,
"value": null
}
],
"basicDescription": [{"languageCode": null,
"value": null
}
],
"detailedDescription": [{"languageCode": null,
"value": null
}
],
"menuSubtitle": [{"languageCode": null,
"value": null
}
],
"images": [{"type": null,
"url": null
}
],
"allergens": [{"id": null,
"token": null,
"type": null
}
],
"nutritionFacts": [{"type": null,
"baseUnit": null,
"relativeUnit": null
}
],
"priceType": "string",
"position": 0,
"preparationMethods": [{"id": 1,
"name": "cold",
"position": 1
}
],
"type": "string"
}
]
}
],
"preparationMethods": [{"id": 1,
"name": "cold",
"position": 1
}
],
"servingSize": "string",
"quantity": 0
}
]
}
]

get a menu tree by its identifier

Authorizations:

api_key

path Parameters

identifier

required

string

Responses

Response samples

Content type

application/json

[{"id": 0,
"names": [{"languageCode": "string",
"value": "string"
}
],
"position": 0,
"menus": [{"id": 0,
"names": [{"languageCode": "string",
"value": "string"
}
],
"position": 1,
"menus": [{"id": 0,
"names": [{"languageCode": "string",
"value": "string"
}
],
"position": 1
}
],
"articles": [{"id": 0,
"names": [{"languageCode": "string",
"value": "string"
}
],
"position": 1
}
]
}
]
}
]

get active status of all menu articles

Authorizations:

api_key

query Parameters

menuId

integer

id of menu that was published at shop

Responses

Response samples

Content type

application/json

[{"articleStatus": [{"articleId": 123,
"distributionChannelId": 12,
"active": true
}
]
}
]

get active status of all articles

Returns active state of all articles for the authenticated division. This is much faster than than only getting articles associated with a specific menu

Authorizations:

api_key

Responses

Response samples

Content type

application/json

[{"articleStatus": [{"articleId": 123,
"distributionChannelId": 12,
"active": true
}
]
}
]