Create Item

POST/v3/service

Request Parameters

serviceString

alacarte service

Example: "alacarte"

versionString

Currently only support 'v1"

Example: "v1"

functionString

Function that provide by alacarte

Example: "create.item"

requestObject

Refer to explanation below

Example: (Refer to explanation below)

Inside request (parameter)

storeIdString

ID of the Store that Create from RM

Example: "1556079400120532579"

nameString

Item name

Example: "test123"

descriptionString

Item description

Example: "Describe"

imageUrlArray

Input your image

Example: []

isAvailableBool

Item available

Example: true

quantityUint

Item quantity

Example: 350

priceObject

Refer to explanation below

Example: (Refer to explanation below)

sidesArray

Refer to explanation below

Example: (Refer to explanation below)

preferencesArray

Refer to explanation below

Example: (Refer to explanation below)

schedulesArray

Schedules startAt and endAt

Example: ["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"]

categoryIdsArray

ID of the Category

Example: ["5ec1bf480e7df1ca6f3f6350"]

skuString

Item SKU

Example: "fkj31i"

Inside Price (parameter)

amountUint

Amount in cent (min RM 0.10 10 = RM 0.10)

Example: 100

currencyTypeString

Current only support Ringgit Malaysia

Example: "MYR"

Inside Sides (parameter)

nameString

Side additional name

Example: "Side Category 1"

minChoiceUint

Set minimum choice

Example: 1

maxChoiceUint

Set maximum choice

Example: 2

isAvailableBool

Item sides is available

Example: true

itemsArray

Refer to explanation below

Example: (Refer to explanation below)

Inside items (parameter)

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

referenceItemIdString

Item reference ID

Example: "5eaa7b72e0e9cd7b01a3a2b2"

nameString

Item name

Example: "Coke"

priceArray

Refer to the Price parameter

Example: ( Refer to the Price parameter)

isAvailableBool

Item sides is available

Example: true

Inside Preferences (parameter)

nameString

Preferences name

Example: "Sweetness"

minChoiceUint

Set minimum choice

Example: 1

maxChoiceUint

Set maximum choice

Example: 3

labelsArray

Refer to explanation below

Example: (Refer to explanation below)

Inside Labels (parameter)

nameString

Label name

Example: "Basic"

Response Parameters

categoryIdString

Category ID

Example: ""

categoryNameString

Name of Category

Example: ""

createdAtDateTime

Creation date time

Example: "2020-09-22T04:44:57.950398414Z"

descriptionString

Description of the item

Example: "Describe"

imageUrlArray

Item image

Example: []

isAvailableBool

Item available

Example: true

itemIdString

Item ID

Example: "5f866a202bdcc5950fcf3c8b"

nameString

Item name

Example: "Test123"

positionUint

Current position among item

Example: 2

preferencesArray

Refer to explanation below

Example: (Refer to explanation below)

priceObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

quantityUint

Item quantity

Example: 350

schedulesArray

Schedules startAt and endAt

Example: ["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"]

sidesArray

Refer to explanation below

Example: (Refer to explanation below)

skuString

Item SKU

Example: "fkj31i"

updatedAtDateTime

Last update date time

Example: "2020-09-22T04:44:57.950398414Z"

Inside Preferences (parameter)

idString

Preferences ID

Example: "5f698149585d7cc1ae35a38d"

nameString

Preferences name

Example: "Sweetness"

minChoiceUint

Set minimum choice

Example: 1

maxChoiceUint

Set maximum choice

Example: 3

labelsArray

Refer to explanation below

Example: (Refer to explanation below)

Inside Labels (parameter)

idString

Label ID

Example: "5f698149585d7cc1ae35a38e"

nameString

Label name

Example: "Basic"

Inside Price (parameter)

amountUint

Amount in cent (min RM 0.10 10 = RM 0.10)

Example: 100

currencyTypeString

Current only support Ringgit Malaysia

Example: "MYR"

Inside Sides (parameter)

idString

Side Category ID

Example: "5f698149585d7cc1ae35a395"

nameString

Side Category name

Example: "Side Category 1"

isAvailableBool

Side Category available

Example: true

minChoiceUint

Set minimum choice

Example: 1

maxChoiceUint

Set maximum choice

Example: 3

sideItemsArray

Refer to explanation below

Example: (Refer to explanation below)

Inside Side Items (parameter)

referenceItemIdString

Item reference ID

Example: "5eaa7b72e0e9cd7b01a3a2b2"

idString

Side Item ID

Example: "5f698149585d7cc1ae35a392"

nameString

Side Item name

Example: "Coke"

priceObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

isAvailableBool

Side Item is available

Example: true

Request Parameters
Inside request (parameter)
Inside Price (parameter)
Inside Sides (parameter)
Inside items (parameter)
Inside Preferences (parameter)
Inside Labels (parameter)
Response Parameters
Inside Preferences (parameter)
Inside Labels (parameter)
Inside Price (parameter)
Inside Sides (parameter)
Inside Side Items (parameter)

POSThttps://sb-open.revenuemonster.my/v3/service

No access token

Headers

{}

Body

{
  "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
          }
        ]
      }
    ],
    "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"]
    ],
    "sku": "fkj31i",
    "categoryIds": ["5ec1bf480e7df1ca6f3f6350"]
  }
}

Example Request

▾

1curl \
2  --location \
3  --request POST 'https://sb-open.revenuemonster.my/v3/service' \
4  --header 'Content-Type: application/json' \
5  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMDMtMTMiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVKTE42dFdBMG82MEx3Il0sImV4cCI6MTYwMzI1NDU2OSwiaWF0IjoxNjAwNjYyNTY5LCJpc3MiOiJodHRwczovL3NiLW9hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UTZNenR5b1RFckpzVyIsIm5iZiI6MTYwMDY2MjU2OSwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVKWFZ6ZDN3cmFxVE9SSVFDZ1JWYzJWeUVJeUpxSXp2eU1QVmNRIn0.H3G6UDX7sR9EXtTMNs4Q2OHdhUGIhhCfdlAeOpywH4rDuVOcWXXwzF4Imbx8E7I10vFAJpwYZrEkCWCdCCw-WV11y9VT5kP6k75CeS-ZPMOLcKnC5iFT7vEi07r6ovwty9erlcZeXrtrmEIn3rnLva-dxSg3vZ2MyymoNDk-kV7ltXnkoWW4jtXRls6siLhxeY__8kXn2qa0ojVX4Nm6HmzN_vgi-RKSmToMgsdzTF94Y61QVBWhZfolD2-JpHx4qNlklcUdv8HOJ1QHHWpyoJytaJmvr3GJ5G399LbcTLwxB1p2qPg7z4hpoGNu4AP-ybRJVC3P9q9OscQYDNX-dA' \
6  --header 'X-Signature: sha256 Sty3LNcKA8+WlMHtAgIY+y1xbwnzKsN0UdyKaW+yYIgcTkBAtF7G5Lx251qQITURJ4wiXPDODxhs1nFVmBBing==' \
7  --header 'X-Nonce-Str: VYNknZohxwicZMaWbNdBKUrnrxDtaRhN' \
8  --header 'X-Timestamp: 1528450585' \
9  --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"] ], "sku": "fkj31i", "categoryIds": ["5ec1bf480e7df1ca6f3f6350"] } }'

Example Response▾

1{
2  "item": {
3    "categoryId": "",
4    "categoryName": "",
5    "createdAt": "2020-10-14T03:01:52.103365832Z",
6    "description": "Describe",
7    "imageUrl": [],
8    "isAvailable": true,
9    "itemId": "5f866a202bdcc5950fcf3c8b",
10    "name": "Test123",
11    "position": 2,
12    "preferences": [
13      {
14        "id": "",
15        "labels": [
16          {
17            "id": "5f866a202bdcc5950fcf3c88",
18            "name": "Basic"
19          },
20          {
21            "id": "5f866a202bdcc5950fcf3c89",
22            "name": "Sweeet"
23          },
24          {
25            "id": "5f866a202bdcc5950fcf3c8a",
26            "name": "Very Sweet"
27          }
28        ],
29        "maxChoice": 3,
30        "minChoice": 1,
31        "name": "Sweetness"
32      }
33    ],
34    "price": {
35      "amount": 100,
36      "currencyType": "MYR"
37    },
38    "quantity": 350,
39    "schedules": [
40      ["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"],
41      ["2020-09-22T15:00:00.000Z", "2020-09-22T15:45:00.000Z"]
42    ],
43    "sides": [
44      {
45        "id": "",
46        "isAvailable": true,
47        "maxChoice": 2,
48        "minChoice": 1,
49        "name": "Side Category 1",
50        "sideItems": [
51          {
52            "id": "5f866a202bdcc5950fcf3c8c",
53            "isAvailable": true,
54            "name": "New Drink",
55            "price": {
56              "amount": 312,
57              "currencyType": "MYR"
58            }
59          }
60        ]
61      },
62      {
63        "id": "",
64        "isAvailable": true,
65        "maxChoice": 1,
66        "minChoice": 1,
67        "name": "Side Category 2",
68        "sideItems": [
69          {
70            "id": "5f866a202bdcc5950fcf3c8e",
71            "isAvailable": true,
72            "name": "Salad 2",
73            "price": {
74              "amount": 200,
75              "currencyType": "MYR"
76            }
77          },
78          {
79            "id": "5f866a202bdcc5950fcf3c8f",
80            "isAvailable": true,
81            "name": "Salad 1",
82            "price": {
83              "amount": 100,
84              "currencyType": "MYR"
85            }
86          }
87        ]
88      }
89    ],
90    "sku": "fkj31i",
91    "updatedAt": "2020-10-14T03:01:52.103365832Z"
92  }
93}

Prerequisite

Products

Miscellaneous

Create Item

Request Parameters

Inside request (parameter)

Inside Price (parameter)

Inside Sides (parameter)

Inside items (parameter)

Inside Preferences (parameter)

Inside Labels (parameter)

Response Parameters

Inside Preferences (parameter)

Inside Labels (parameter)

Inside Price (parameter)

Inside Sides (parameter)

Inside Side Items (parameter)