Update a single global Option on the menu
PUT ~/menu/options/:posid
Headers
Field | Type | Description |
---|---|---|
Authorization | String |
Bearer authentication token prefixed with |
Content-Type | String |
Request content type, must be 'application/json' |
vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Parameters
Field | Type | Description |
---|---|---|
:pos-id | string |
The POS id of the global Option to update |
name | String |
The display name of the Option |
min | String |
The minimum number that can be selected (0 for no min) |
max | String |
The maximum number that can be selected (0 for no max) |
variants | Object[] |
The available Variants for the option |
posId | String |
The POS id of the Variant |
name | String |
The display name of the Variant |
price | String |
The price of the Variant in cents |
Response
Field | Type | Description |
---|---|---|
posId | String |
The POS id of the Option |
name | String |
The display name of the Option |
min | String |
The minimum number that can be selected (0 for no min) |
max | String |
The maximum number that can be selected (0 for no max) |
variants | Object[] |
The available Variants for the option |
posId | String |
The POS id of the Variant |
name | String |
The display name of the Variant |
price | String |
The price of the Variant in cents |
Examples
Request
{
"posId": "eggs12",
"name": "Toasted Sourdough & Eggs",
"description": "Just ye old classic",
"unitPrice": "1100",
"type": "single",
"includedItems": [],
"tags": [
"Breakfast",
"Lunch"
],
"surcounts": [{
"posId": "100_percent_discount",
"name": "Free Item",
"amount": "-100",
"type": "percentage"
}],
"options": [{
"name": "How would like the eggs cooked?",
"min": 1,
"max": 1,
"posId": "egg_cook_type",
"variants": [{
"name": "Poached",
"posId": "poached_egg"
}, {
"name": "Scrambled",
"posId": "scrambled_egg"
}, {
"name": "Fried",
"posId": "fried_egg"
}, {
"name": "Hard Boiled",
"posId": "hard_boiled_eggs"
}]
}, {
"posId": "egg_extras",
"name": "Extras",
"min": 0,
"max": 3,
"variants": [{
"posId": "extra_bacon",
"name": "Bacon",
"price": 200
}, {
"posId": "extra_sliced_avocado",
"name": "Sliced Avocado",
"price": 420
}, {
"posId": "extra_chorizo",
"name": "Chorizo",
"price": 420
}]
}]
}
Response
{
"name": "French Fries",
"min": 1,
"max": 1,
"posId": "fries",
"variants": [{
"name": "Small",
"posId": "fries_small"
}, {
"name": "Large",
"posId": "fries_large"
}]
}
Comments
0 comments
Please sign in to leave a comment.