Get Items By Category ID

POST/v3/service

Using categoryId to get items

Request Parameters

serviceString

alacarte service

Example: "alacarte"

versionString

Currently only support 'v1"

Example: "v1"

functionString

Function that provide by alacarte

Example: "get.category.items"

requestObject

Refer to explanation below

Example: (Refer to explanation below)

categoryIdString

ID of the Category

Example: "5eabf31ee0e9cd7b01a3a35e"

Response Parameters

cursorString

Optional, if pagination exists.

Example: ""

countUint

Current page record

Example: 2

itemsObject

(Refer to explanation below)

Example: (Refer to explanation below)

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: "5eaeee9db07a77cef7caceb6"

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

idString

Side Item ID

Example: "5f698149585d7cc1ae35a392"

isAvailableBool

Side Item is available

Example: true

nameString

Side Item name

Example: "Coke"

priceObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

referenceItemIdString

Optional, Item reference ID

Example: "5eaa7b72e0e9cd7b01a3a2b2"

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

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

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

No access token

Headers

{}

Body

{
  "service": "alacarte",
  "version": "v1",
  "function": "get.category.items",
  "request": {
    "categoryId": "5eabf31ee0e9cd7b01a3a35e"
  }
}

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": "get.category.items", "request": { "categoryId": "5eabf31ee0e9cd7b01a3a35e" } }'

Example Response▾

1{
2  "count": 2,
3  "cursor": "",
4  "items": [
5    {
6      "categoryId": "5eabf31ee0e9cd7b01a3a35e",
7      "categoryName": "Chinese Cuisine ",
8      "createdAt": "0001-01-01T00:00:00Z",
9      "description": "yummz",
10      "imageUrl": [
11        "https://smart-cafe-sandbox.oss-ap-southeast-3.aliyuncs.com/images/4118165203679668885/3b198791-fedb-426e-98ef-adb8cd3d6718"
12      ],
13      "isAvailable": false,
14      "itemId": "5eaeee9db07a77cef7caceb6",
15      "name": "Hainan Chicken Rice",
16      "position": 11,
17      "preferences": [],
18      "price": {
19        "amount": 500,
20        "currencyType": "MYR"
21      },
22      "quantity": 380,
23      "schedules": [
24        ["2020-09-22T02:00:00.000Z", "2020-09-22T14:00:00.000Z"],
25        ["2020-09-22T15:00:00.000Z", "2020-09-22T15:45:00.000Z"]
26      ],
27      "sides": [
28        {
29          "id": "",
30          "isAvailable": false,
31          "maxChoice": 1,
32          "minChoice": 0,
33          "name": "test",
34          "sideItems": [
35            {
36              "id": "5f865c458590c3866c35b1a8",
37              "isAvailable": false,
38              "name": "Tandoori Chicken",
39              "price": {
40                "amount": 1000,
41                "currencyType": "MYR"
42              }
43            }
44          ]
45        }
46      ],
47      "updatedAt": "2020-10-14T02:02:45.102Z"
48    },
49    {
50      "categoryId": "5eabf31ee0e9cd7b01a3a35e",
51      "categoryName": "Chinese Cuisine ",
52      "createdAt": "0001-01-01T00:00:00Z",
53      "description": "",
54      "imageUrl": [
55        "https://smart-cafe-sandbox.oss-ap-southeast-3.aliyuncs.com/images/4118165203679668885/16af5d54-f96b-42eb-9d73-6cc9ff220d92"
56      ],
57      "isAvailable": true,
58      "itemId": "5eaeeffeb07a77cef7caced1",
59      "name": "Penang Char Kuey Teow",
60      "position": 12,
61      "preferences": [],
62      "price": {
63        "amount": 200,
64        "currencyType": "MYR"
65      },
66      "quantity": 0,
67      "schedules": null,
68      "sides": [],
69      "sku": "fkj31i",
70      "updatedAt": "2020-09-29T04:33:52.303Z"
71    }
72  ]
73}

Prerequisite

Products

Miscellaneous

Get Items By Category ID

Request Parameters

Response Parameters

Inside Sides (parameter)

Inside Side Items (parameter)

Inside Price (parameter)

Inside Preferences (parameter)

Inside Labels (parameter)