Update Category By ID

Update a category's name, status, or position in the menu order.

When to Use

▾

Use this endpoint when:

• Renaming a category (e.g., "Drinks" → "Beverages")
• Activating / deactivating a category
• Re-ordering categories on the menu

How to Use

▾

Endpoint

POST/v3/service

POST function: "update.category" with categoryId and the changed fields. Use positionChange 1 to move down, -1 to move up.

---

Request Parameters

▾

serviceSTRING

alacarte service

Example: "alacarte"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Function that provide by alacarte

Example: "update.category"

requestOBJECT

Request body

categoryIdSTRING

ID of the Category

Example: "5f68485ccb3285b9d3955696"

nameSTRING

Category name

Example: "Drinks"

statusSTRING

Status of Category "ACTIVE" and "INACTIVE"

Example: "ACTIVE"

positionChangeINTEGER

Move UP or DOWN the position using -1 or 1

Example: 1

Response Parameters

▾

itemOBJECT

Updated category

categoryIdSTRING

Category ID

Example: "5f68485ccb3285b9d3955696"

storeIdSTRING

ID of the Store that Create from RM

Example: "10946114768247530"

itemIdsARRAY

Category Items

Example: null

nameSTRING

Item Name

Example: "Drinks"

statusSTRING

Status of Item

Example: "ACTIVE"

positionINTEGER

Current position among Category

Example: 1

createdAtDATETIME

Creation date time

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

updatedAtDATETIME

Last update date time

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