Skip to main content

Update Item By ID

Method : POST

URL: https://open.revenuemonster.my/v3/service

Sandbox URL: https://sb-open.revenuemonster.my/v3/service

Request Parameters

ParameterTypeDescriptionExample
serviceStringalacarte service"alacarte"
versionStringCurrently only support 'v1""v1"
functionStringFunction that provide by alacarte"update.items"
requestObjectRefer to explanation below(Refer to explanation below)
ParameterTypeDescriptionExample
itemIdStringItem ID"5f698149585d7cc1ae35a395"
categoryIdArrayCategory ID["5eabf31ee0e9cd7b01a3a35e"]
nameStringItem name"Hainan Chicken Rice"
descriptionStringItem description"yummz"
imageUrlArrayInput your image[]
isAvailableBoolItem availabletrue
priceObjectRefer to explanation below(Refer to explanation below)
quantityUintItem quantity380
sidesArrayRefer to explanation below(Refer to explanation below)
preferencesArrayRefer to explanation below(Refer to explanation below)
schedulesArraySchedules startAt and endAt["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"]
skuStringItem SKU"fkj31i"

Inside Sides (parameter)

ParameterTypeDescriptionExample
nameStringSide Category name"Side Category 1"
isAvailableBoolSide Category availabletrue
minChoiceUintSet minimum choice1
maxChoiceUintSet maximum choice3
sideItemsArrayRefer to explanation below(Refer to explanation below)

Inside Side Items (parameter)

ParameterTypeDescriptionExample
referenceItemIdStringOptional, Item reference ID"5eaa7b72e0e9cd7b01a3a2b2"
idStringSide Item ID"5f698149585d7cc1ae35a392"
nameStringSide Item name"Coke"
priceObjectRefer to the Price parameter( Refer to the Price parameter)
isAvailableBoolSide Item is availabletrue

Inside Price (parameter)

ParameterTypeDescriptionExample
amountUintAmount in cent (min RM 0.10 10 = RM 0.10)100
currencyTypeStringCurrent only support Ringgit Malaysia"MYR"

Inside Preferences (parameter)

ParameterTypeDescriptionExample
idStringPreferences ID"5f698149585d7cc1ae35a38d"
nameStringPreferences name"Sweetness"
minChoiceUintSet minimum choice1
maxChoiceUintSet maximum choice3
labelsArrayRefer to explanation below(Refer to explanation below)

Inside Labels (parameter)

ParameterTypeDescriptionExample
idStringLabel ID"5f698149585d7cc1ae35a38e"
nameStringLabel name"Basic"

Example Request

curl --location --request POST 'https://sb-open.revenuemonster.my/v3/service' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMDMtMTMiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVKTE42dFdBMG82MEx3Il0sImV4cCI6MTYwMzI1NDU2OSwiaWF0IjoxNjAwNjYyNTY5LCJpc3MiOiJodHRwczovL3NiLW9hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UTZNenR5b1RFckpzVyIsIm5iZiI6MTYwMDY2MjU2OSwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVKWFZ6ZDN3cmFxVE9SSVFDZ1JWYzJWeUVJeUpxSXp2eU1QVmNRIn0.H3G6UDX7sR9EXtTMNs4Q2OHdhUGIhhCfdlAeOpywH4rDuVOcWXXwzF4Imbx8E7I10vFAJpwYZrEkCWCdCCw-WV11y9VT5kP6k75CeS-ZPMOLcKnC5iFT7vEi07r6ovwty9erlcZeXrtrmEIn3rnLva-dxSg3vZ2MyymoNDk-kV7ltXnkoWW4jtXRls6siLhxeY__8kXn2qa0ojVX4Nm6HmzN_vgi-RKSmToMgsdzTF94Y61QVBWhZfolD2-JpHx4qNlklcUdv8HOJ1QHHWpyoJytaJmvr3GJ5G399LbcTLwxB1p2qPg7z4hpoGNu4AP-ybRJVC3P9q9OscQYDNX-dA' \
--header 'X-Signature: sha256 Sty3LNcKA8+WlMHtAgIY+y1xbwnzKsN0UdyKaW+yYIgcTkBAtF7G5Lx251qQITURJ4wiXPDODxhs1nFVmBBing==' \
--header 'X-Nonce-Str: VYNknZohxwicZMaWbNdBKUrnrxDtaRhN' \
--header 'X-Timestamp: 1528450585' \
--data-raw '{
"service": "alacarte",
"version": "v1",
"function": "update.item",
"request": {
"itemId": "5eaeee9db07a77cef7caceb6",
"categoryId": ["5eabf31ee0e9cd7b01a3a35e"],
"name": "Hainan Chicken Rice",
"description": "yummz",
"imageUrl": [
"https://smart-cafe-sandbox.oss-ap-southeast-3.aliyuncs.com/images/4118165203679668885/3b198791-fedb-426e-98ef-adb8cd3d6718"
],
"isAvailable": true,
"price": { "amount": 500, "currencyType": "MYR" },
"quantity": 380,
"sides": [
{
"name": "test",
"minChoice": 0,
"maxChoice": 1,
"isAvailable": true,
"items": [
{
"alaCarteFoodId": "5eaef304b07a77cef7cacee3",
"name": "Tandoori Chicken",
"price": { "amount": 1000, "currencyType": "MYR" },
"isAvailable": true
}
]
}
],
"preferences": [],
"schedules": [
["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"],
["2020-09-22T15:00:00.000Z", "2020-09-22T15:45:00.000Z"]
]
"sku": "fkj31i",
}
}'

Response Parameters

ParameterTypeDescriptionExample
categoryIdStringCategory ID""
categoryNameStringName of Category""
createdAtDateTimeCreation date time"2020-09-22T04:44:57.950398414Z"
descriptionStringDescription of the item"Describe"
imageUrlArrayItem image[]
isAvailableBoolItem availabletrue
itemIdStringItem ID"5f698149585d7cc1ae35a391"
nameStringItem name"Test123"
positionUintCurrent position among item2
preferencesArrayRefer to explanation below(Refer to explanation below)
priceObjectRefer to the Price parameter( Refer to the Price parameter)
quantityUintItem quantity350
schedulesArraySchedules startAt and endAt["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"]
sidesArrayRefer to explanation below(Refer to explanation below)
skuStringItem SKU"fkj31i"
updatedAtDateTimeLast update date time"2020-09-22T04:44:57.950398414Z"

Inside Sides (parameter)

ParameterTypeDescriptionExample
idStringSide Category ID"5f698149585d7cc1ae35a395"
nameStringSide Category name"Side Category 1"
isAvailableBoolSide Category availabletrue
minChoiceUintSet minimum choice1
maxChoiceUintSet maximum choice3
sideItemsArrayRefer to explanation below(Refer to explanation below)

Inside Side Items (parameter)

ParameterTypeDescriptionExample
referenceItemIdStringOptional, Item reference ID"5eaa7b72e0e9cd7b01a3a2b2"
idStringSide Item ID"5f698149585d7cc1ae35a392"
nameStringSide Item name"Coke"
priceObjectRefer to the Price parameter( Refer to the Price parameter)
isAvailableBoolSide Item is availabletrue

Inside Price (parameter)

ParameterTypeDescriptionExample
amountUintAmount in cent (min RM 0.10 10 = RM 0.10)100
currencyTypeStringCurrent only support Ringgit Malaysia"MYR"

Inside Preferences (parameter)

ParameterTypeDescriptionExample
idStringPreferences ID"5f698149585d7cc1ae35a38d"
nameStringPreferences name"Sweetness"
minChoiceUintSet minimum choice1
maxChoiceUintSet maximum choice3
labelsArrayRefer to explanation below(Refer to explanation below)

Inside Labels (parameter)

ParameterTypeDescriptionExample
idStringLabel ID"5f698149585d7cc1ae35a38e"
nameStringLabel name"Basic"

Example Response

{
"item": {
"categoryId": "5eabf31ee0e9cd7b01a3a35e",
"categoryName": "Chinese Cuisine ",
"createdAt": "0001-01-01T00:00:00Z",
"description": "yummz",
"imageUrl": [
"https://smart-cafe-sandbox.oss-ap-southeast-3.aliyuncs.com/images/4118165203679668885/3b198791-fedb-426e-98ef-adb8cd3d6718"
],
"isAvailable": true,
"itemId": "5eaeee9db07a77cef7caceb6",
"name": "Hainan Chicken Rice",
"position": 11,
"preferences": [],
"price": {
"amount": 500,
"currencyType": "MYR"
},
"quantity": 380,
"schedules": [
["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"],
["2020-09-22T15:00:00.000Z", "2020-09-22T15:45:00.000Z"]
],
"sides": [
{
"id": "",
"isAvailable": true,
"maxChoice": 1,
"minChoice": 0,
"name": "test",
"sideItems": [
{
"id": "5f8672de72b118cb92ddf05d",
"isAvailable": false,
"name": "Tandoori Chicken",
"price": {
"amount": 1000,
"currencyType": "MYR"
}
}
]
}
],
"sku": "fkj31i",
"updatedAt": "2020-10-14T03:39:10.861054794Z"
}
}