Skip to main content

Create Item

Create a new menu item in an à la carte store — name, price, sides, preferences, schedules, and category assignment.

When to Use

Use this endpoint when:

  • Adding a new menu item to a store
  • Defining sides (e.g., drink with combo) and customer preferences (e.g., sweetness levels)
  • Scheduling item availability windows

How to Use

Endpoint
POST/v3/service

Step 1: Identify the Store

Use the storeId for the à la carte store.

Step 2: Build the Item

Set name, price, quantity, and optional sides, preferences, schedules, and categoryIds.

Step 3: Send the Request

POST with function: "create.item" and the request payload.


Request Parameters

serviceSTRING

alacarte service

Example: "alacarte"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Function that provide by alacarte

Example: "create.item"

requestOBJECT

Request body

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

isAvailableBOOLEAN

Item available

Example: true

quantityINTEGER

Item quantity

Example: 350

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"

sidesARRAY

Item sides

nameSTRING

Side additional name

Example: "Side Category 1"

minChoiceINTEGER

Set minimum choice

Example: 1

maxChoiceINTEGER

Set maximum choice

Example: 2

isAvailableBOOLEAN

Item sides is available

Example: true

itemsARRAY

Side items

referenceItemIdSTRING

Item reference ID

Example: "5eaa7b72e0e9cd7b01a3a2b2"

nameSTRING

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"

isAvailableBOOLEAN

Item sides is available

Example: true

preferencesARRAY

Item preferences

nameSTRING

Preferences name

Example: "Sweetness"

minChoiceINTEGER

Set minimum choice

Example: 1

maxChoiceINTEGER

Set maximum choice

Example: 3

labelsARRAY

Preference labels

nameSTRING

Label name

Example: "Basic"

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"

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

isAvailableBOOLEAN

Item available

Example: true

itemIdSTRING

Item ID

Example: "5f866a202bdcc5950fcf3c8b"

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"