Remove a single Product from the menu
DELETE ~/menu/products/:pos-id
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 Product to remove |
Response
Field | Type | Description |
---|---|---|
surcounts | Object[] |
Array of Surcount objects that can be applied to an Order |
posId | String |
The POS id of the Surcount |
name | String |
The display name |
amount | String |
The amount to surcharge/discount (positive/negative integer) |
type | String |
Whether this is a 'absolute' or 'percentage' |
products | Object[] |
Array of Product objects |
posId | String |
The POS id of the Product |
name | String |
The display name of the Product |
description | String |
A short description of the Product |
unitPrice | String |
The price of the Product in cents |
tags | String[] |
Array of strings to help group Products together |
menuDir | String[] |
An array of strings representing a menu directory. Eg. For a Flat White - |
options | Object[] |
Array of options that can be added to the Product |
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 |
surcounts | Object[] |
Array of Surcount objects that can be applied to a Product |
posId | String |
The POS id of the Surcount |
name | String |
The display name of the Surcount |
amount | String |
The amount in cents to surcharge/discount (positive/negative) |
type | String |
Whether this is an 'absolute' or 'percentage' Surcount |
Examples
Response
{
"products": [{
"posId": "eggs12",
"name": "Toasted Sourdough & Eggs",
"description": "Just ye old classic",
"type": "single",
"includedItems": [],
"unitPrice": "1100",
"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
}]
}]
}],
"surcounts": [{
"posId": "10_percent_discount",
"name": "10% Discount",
"amount": "-10",
"type": "percentage"
}, {
"posId": "3_dollar_surcharge",
"name": "$3 surcharge",
"amount": "300",
"type": "absolute"
}, {
"posId": "5_dollar_discount",
"name": "$5 discount",
"amount": "-500",
"type": "absolute"
}],
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z"
}
Comments
0 comments
Please sign in to leave a comment.