Skip to main content
POST
Preview an accepted configuration within a released menu

Path Parameters

locationId
string
required
Required string length: 1 - 128
productId
string
required
Required string length: 1 - 128

Body

application/json
menuId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
channel
enum<string>
required
Available options:
online,
catering
menuReleaseId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
quantityUnit
enum<string>
required
Available options:
serving,
person,
item,
dozen,
tray,
pack,
lb,
oz,
kg,
g,
gallon,
quart,
liter,
ml,
fl_oz
quantity
integer
required
Required range: 1 <= x <= 99
preferences
object
required
selections
object[]
Maximum array length: 50

Response

Server food facts and structured dietary warnings.

source
object
required
contributions
object[]
required
Maximum array length: 10000
serving
object
required
quantity
object
required
trayYield
object | null
required
perServing
object
required
perTray
object | null
required
lineTotal
object
required
completeness
enum<string>
required
Available options:
complete,
partial,
unknown
missing
object[]
required
Maximum array length: 10000
warnings
object[]
required
Maximum array length: 10000