Skip to main content

Get Categories By Store ID

List all menu categories for a specific store.

When to Use

Use this endpoint when:

  • Rendering a menu by category
  • Looking up categoryId before fetching items

How to Use

Endpoint
POST/v3/service

POST function: "get.categories" with the storeId.


Request Parameters

serviceSTRING

alacarte service

Example: "alacarte"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Function that provide by alacarte

Example: "get.categories"

requestOBJECT

Request body

storeIdSTRING

ID of the Store that Create from RM

Example: "1556079400120532579"

Response Parameters

itemsARRAY

List of categories

categoryIdSTRING

Category ID

Example: "5f68485ccb3285b9d3955696"

storeIdSTRING

ID of the Store that Create from RM

Example: "1556079400120532579"

itemIdsARRAY

Category Items

Example: ["5f68485ccb3285b9d3955699"]

nameSTRING

Item Name

Example: "Drinks"

statusSTRING

Status of Category "ACTIVE" and "INACTIVE"

Example: "ACTIVE"

positionINTEGER

Current position among Category

Example: 0

createdAtDATETIME

Creation date time

Example: "2020-09-21T06:29:48.839Z"

updatedAtDATETIME

Last update date time

Example: "2020-09-21T06:29:48.839Z"

cursorSTRING

Optional, if pagination exists.

Example: "0"

countINTEGER

Current page record

Example: 2