Get Items By Category ID

Retrieve all menu items in a specific category by its categoryId.

When to Use

▾

Use this endpoint when:

• Listing items grouped by category
• Building a category-driven menu UI

How to Use

▾

Endpoint

POST/v3/service

Step 1: Get the Category ID

▾

Use the categoryId from Get Categories By Store ID.

Step 2: Send the Query

▾

POST function: "get.category.items" with the categoryId.

---

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

Request body

categoryIdSTRING

ID of the Category

Example: "5eabf31ee0e9cd7b01a3a35e"

Response Parameters

▾

cursorSTRING

Optional, if pagination exists.

Example: ""

countINTEGER

Current page record

Example: 2

itemsARRAY

List of items

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: []

isAvailableBOOLEAN

Item available

Example: true

itemIdSTRING

Item ID

Example: "5eaeee9db07a77cef7caceb6"

nameSTRING

Item name

Example: "Test123"

positionINTEGER

Current position among item

Example: 2

preferencesARRAY

Item preferences

idSTRING

Preferences ID

Example: "5f698149585d7cc1ae35a38d"

nameSTRING

Preferences name

Example: "Sweetness"

minChoiceINTEGER

Set minimum choice

Example: 1

maxChoiceINTEGER

Set maximum choice

Example: 3

labelsARRAY

Preference labels

idSTRING

Label ID

Example: "5f698149585d7cc1ae35a38e"

nameSTRING

Label name

Example: "Basic"

priceOBJECT

Item price

amountINTEGER

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

Example: 100

currencyTypeSTRING

Current only support Ringgit Malaysia

Example: "MYR"

quantityINTEGER

Item quantity

Example: 350

schedulesARRAY

Schedules startAt and endAt

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

sidesARRAY

Item sides

idSTRING

Side Category ID

Example: "5f698149585d7cc1ae35a395"

nameSTRING

Side Category name

Example: "Side Category 1"

isAvailableBOOLEAN

Side Category available

Example: true

minChoiceINTEGER

Set minimum choice

Example: 1

maxChoiceINTEGER

Set maximum choice

Example: 3

sideItemsARRAY

Side items

idSTRING

Side Item ID

Example: "5f698149585d7cc1ae35a392"

isAvailableBOOLEAN

Side Item is available

Example: true

nameSTRING

Side Item name

Example: "Coke"

priceOBJECT

Side item price

amountINTEGER

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

Example: 100

currencyTypeSTRING

Current only support Ringgit Malaysia

Example: "MYR"

skuSTRING

Item SKU

Example: "fkj31i"

updatedAtDATETIME

Last update date time

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