Create Category

Create a new menu category in an à la carte store.

When to Use

▾

Use this endpoint when:

• Adding a new menu category (e.g., "Drinks", "Desserts")
• Setting up a fresh store's menu structure

How to Use

▾

Endpoint

POST/v3/service

POST function: "create.category" with storeId, name, and status.

---

Request Parameters

▾

serviceSTRING

alacarte service

Example: "alacarte"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Function that provide by alacarte

Example: "create.category"

requestOBJECT

Request body

storeIdSTRING

ID of the Store that Create from RM

Example: "1556079400120532579"

nameSTRING

Category name

Example: "Drinks"

statusSTRING

Status of Category "ACTIVE" and "INACTIVE"

Example: "ACTIVE"

Response Parameters

▾

cursorSTRING

Optional, if pagination exists.

Example: ""

countINTEGER

Current page record

Example: 1

itemsARRAY

Created categories

categoryIdSTRING

Category ID

Example: "5f697cb3585d7cc1ae35a37f"

storeIdSTRING

ID of the Store that Create from RM

Example: "1556079400120532579"

itemIdsARRAY

Category Items

Example: null

nameSTRING

Item Name

Example: "Drinks"

statusSTRING

Status of Category "ACTIVE" and "INACTIVE"

Example: "ACTIVE"

positionINTEGER

Current position among Category

Example: 7

createdAtDATETIME

Creation date time

Example: "2020-09-22T04:25:23.684330293Z"

updatedAtDATETIME

Last update date time

Example: "2020-09-22T04:25:23.684330293Z"