Skip to main content
GET
Get a published product

Path Parameters

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

Query Parameters

orderDate
string
Minimum string length: 1
orderTime
string
Minimum string length: 1
menuOnly
boolean
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)$

Response

Published product.

id
string
required
Required string length: 1 - 128
name
string
required
price
string
required
Pattern: ^-?\d+(?:\.\d+)?$
displayPrice
string
required
currency
enum<string>
required
Available options:
usd,
gbp,
aed,
aud
modifierIds
string[]
required
Required string length: 1 - 128
description
string
required
availability
string
required
images
string[]
required
source
object
required
quantityUnit
enum<string>
required
Available options:
serving,
person,
item,
dozen,
tray,
pack,
lb,
oz,
kg,
g,
gallon,
quart,
liter,
ml,
fl_oz
locationId
string
required
Required string length: 1 - 128
modifiers
object[]
required
sellability
object
{key}
any