Create Item

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"create.item"
requestObjectRefer to explanation below(Refer to explanation below)

Inside request (parameter)#

ParameterTypeDescriptionExample
storeIdStringID of the Store that Create from RM"1556079400120532579"
nameStringItem name"test123"
descriptionStringItem description"Describe"
imageUrlArrayInput your image[]
isAvailableBoolItem availabletrue
quantityUintItem quantity350
priceObjectRefer to explanation below(Refer to explanation below)
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"]
categoryIdsArrayID of the Category["5ec1bf480e7df1ca6f3f6350"]

Inside Price (parameter)#

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

Inside Sides (parameter)#

ParameterTypeDescriptionExample
nameStringSide additional name"Side Category 1"
minChoiceUintSet minimum choice1
maxChoiceUintSet maximum choice2
isAvailableBoolItem sides is availabletrue
itemsArrayRefer to explanation below(Refer to explanation below)

Inside items (parameter)#

note

For referenceItemId is an Optional if you have a item that already create you can put inside the sides item , but the isAvailable will be default true.

You still can change the name and price

ParameterTypeDescriptionExample
referenceItemIdStringItem reference ID"5eaa7b72e0e9cd7b01a3a2b2"
nameStringItem name"Coke"
priceArrayRefer to the Price parameter( Refer to the Price parameter)
isAvailableBoolItem sides is availabletrue

Inside Preferences (parameter)#

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

Inside Labels (parameter)#

ParameterTypeDescriptionExample
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": "create.item",
"request": {
"storeId": "1556079400120532579",
"name": "Test123",
"description": "Describe",
"imageUrl": [],
"isAvailable": true,
"quantity": 350,
"price": { "amount": 100, "currencyType": "MYR" },
"sides": [
{
"name": "Side Category 1",
"minChoice": 1,
"maxChoice": 2,
"isAvailable": true,
"items": [
{
"referenceItemId": "5eaa7b72e0e9cd7b01a3a2b2",
"name": "Coke",
"price": { "amount": 10, "currencyType": "MYR" },
"isAvailable": true
},
{
"name": "New Drink",
"price": { "amount": 312, "currencyType": "MYR" },
"isAvailable": true
}
]
},
{
"name": "Side Category 2",
"minChoice": 1,
"maxChoice": 1,
"isAvailable": true,
"items": [
{
"name": "Salad 2",
"price": { "amount": 200, "currencyType": "MYR" },
"isAvailable": true
},
{
"name": "Salad 1",
"price": { "amount": 100, "currencyType": "MYR" },
"isAvailable": true
}
]
}
],
"preferences": [
{
"name": "Sweetness",
"minChoice": 1,
"maxChoice": 3,
"labels": [
{ "name": "Basic" },
{ "name": "Sweeet" },
{ "name": "Very Sweet" }
]
}
],
"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"]
],
"categoryIds": ["5ec1bf480e7df1ca6f3f6350"]
}
}'

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"5f866a202bdcc5950fcf3c8b"
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)
updatedAtDateTimeLast update date time"2020-09-22T04:44:57.950398414Z"

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"

Inside Price (parameter)#

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

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
referenceItemIdStringItem 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

Example Response

{
"item": {
"categoryId": "",
"categoryName": "",
"createdAt": "2020-10-14T03:01:52.103365832Z",
"description": "Describe",
"imageUrl": [],
"isAvailable": true,
"itemId": "5f866a202bdcc5950fcf3c8b",
"name": "Test123",
"position": 2,
"preferences": [
{
"id": "",
"labels": [
{
"id": "5f866a202bdcc5950fcf3c88",
"name": "Basic"
},
{
"id": "5f866a202bdcc5950fcf3c89",
"name": "Sweeet"
},
{
"id": "5f866a202bdcc5950fcf3c8a",
"name": "Very Sweet"
}
],
"maxChoice": 3,
"minChoice": 1,
"name": "Sweetness"
}
],
"price": {
"amount": 100,
"currencyType": "MYR"
},
"quantity": 350,
"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": 2,
"minChoice": 1,
"name": "Side Category 1",
"sideItems": [
{
"id": "5f866a202bdcc5950fcf3c8c",
"isAvailable": true,
"name": "New Drink",
"price": {
"amount": 312,
"currencyType": "MYR"
}
}
]
},
{
"id": "",
"isAvailable": true,
"maxChoice": 1,
"minChoice": 1,
"name": "Side Category 2",
"sideItems": [
{
"id": "5f866a202bdcc5950fcf3c8e",
"isAvailable": true,
"name": "Salad 2",
"price": {
"amount": 200,
"currencyType": "MYR"
}
},
{
"id": "5f866a202bdcc5950fcf3c8f",
"isAvailable": true,
"name": "Salad 1",
"price": {
"amount": 100,
"currencyType": "MYR"
}
}
]
}
],
"updatedAt": "2020-10-14T03:01:52.103365832Z"
}
}