Docs
Api reference

Menu Item

Download Excel template for menu items bulk upload

GET
/api/menu-items/template

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

curl -X GET "https://example.com/api/menu-items/template"
"string"

List MenuItem

GET
/api/menu-items

Query Parameters

no?string
restaurantId?string
categoryId?string
page?integer
Range0 < value
Default1
limit?integer
Range0 < value <= 100
Default10
search?string

Response Body

application/json

curl -X GET "https://example.com/api/menu-items"
{  "success": true,  "data": [    {      "categoryId": 1,      "menuUID": "string",      "name": "string",      "description": "string",      "price": 1,      "servesPeople": "string",      "ingredients": "string",      "spiceLevel": "string",      "allergens": "string",      "similarItems": "string",      "imageUrl": "http://example.com",      "isAvailable": true,      "taxRates": [        null      ],      "modifierGroups": [        null      ],      "tags": [        null      ],      "id": 1,      "createdAt": "string",      "updatedAt": "string"    }  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}

Create a new MenuItem

POST
/api/menu-items

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/menu-items" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "price": 1  }'
{  "success": true,  "menuItem": {    "categoryId": 1,    "menuUID": "string",    "name": "string",    "description": "string",    "price": 1,    "servesPeople": "string",    "ingredients": "string",    "spiceLevel": "string",    "allergens": "string",    "similarItems": "string",    "imageUrl": "http://example.com",    "isAvailable": true,    "taxRates": [      null    ],    "modifierGroups": [      null    ],    "tags": [      null    ]  }}

Semantic search for MenuItems

GET
/api/menu-items/search

Query Parameters

query*string

Search query string (e.g. 'spicy pasta')

no?string

Restaurant phone number

restaurantId?string

Restaurant ID

limit?string

Maximum number of results to return

Default"5"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/menu-items/search?query=string"
{  "success": true,  "data": [    {      "id": 0,      "menuUID": "string",      "name": "string",      "price": "string",      "description": "string",      "ingredients": "string",      "servesPeople": "string",      "spiceLevel": "string",      "allergens": "string",      "imageUrl": "string",      "isAvailable": true,      "similarity": 0,      "category": {        "id": 0,        "name": "string"      },      "taxRates": [        null      ],      "modifierGroups": [        null      ]    }  ]}

Semantic search for MenuItems (POST version)

POST
/api/menu-items/search

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/menu-items/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
{  "success": true,  "data": [    {      "id": 0,      "menuUID": "string",      "name": "string",      "price": "string",      "description": "string",      "ingredients": "string",      "servesPeople": "string",      "spiceLevel": "string",      "allergens": "string",      "imageUrl": "string",      "isAvailable": true,      "similarity": 0,      "category": {        "id": 0,        "name": "string"      },      "taxRates": [        null      ],      "modifierGroups": [        null      ]    }  ]}

Fetch MenuItem by menuUID or ID

GET
/api/menu-items/{menuUID}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

menuUID*string

Response Body

application/json

application/json

curl -X GET "https://example.com/api/menu-items/string"
{  "success": true,  "menuItem": {    "categoryId": 1,    "menuUID": "string",    "name": "string",    "description": "string",    "price": 1,    "servesPeople": "string",    "ingredients": "string",    "spiceLevel": "string",    "allergens": "string",    "similarItems": "string",    "imageUrl": "http://example.com",    "isAvailable": true,    "taxRates": [      null    ],    "modifierGroups": [      null    ],    "tags": [      null    ],    "id": 1,    "createdAt": "string",    "updatedAt": "string",    "category": {      "cloverId": "string",      "name": "string",      "description": "string",      "displayOrder": 0,      "id": 1,      "createdAt": "string",      "updatedAt": "string"    }  }}

Fetch MenuItem by ID from request body

POST
/api/menu-items/detail

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/menu-items/detail" \  -H "Content-Type: application/json" \  -d '{    "id": 0  }'
{  "success": true,  "menuItem": {    "categoryId": 1,    "menuUID": "string",    "name": "string",    "description": "string",    "price": 1,    "servesPeople": "string",    "ingredients": "string",    "spiceLevel": "string",    "allergens": "string",    "similarItems": "string",    "imageUrl": "http://example.com",    "isAvailable": true,    "taxRates": [      null    ],    "modifierGroups": [      null    ],    "tags": [      null    ],    "id": 1,    "createdAt": "string",    "updatedAt": "string",    "category": {      "cloverId": "string",      "name": "string",      "description": "string",      "displayOrder": 0,      "id": 1,      "createdAt": "string",      "updatedAt": "string"    }  }}

Delete MenuItem by ID

DELETE
/api/menu-items/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*number

Response Body

application/json

application/json

curl -X DELETE "https://example.com/api/menu-items/0"
{  "success": true,  "message": "string"}

Update MenuItem

PUT
/api/menu-items/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*number

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/api/menu-items/0" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "menuItem": {    "categoryId": 1,    "menuUID": "string",    "name": "string",    "description": "string",    "price": 1,    "servesPeople": "string",    "ingredients": "string",    "spiceLevel": "string",    "allergens": "string",    "similarItems": "string",    "imageUrl": "http://example.com",    "isAvailable": true,    "taxRates": [      null    ],    "modifierGroups": [      null    ],    "tags": [      null    ]  }}

Bulk Delete MenuItems

POST
/api/menu-items/bulk-delete

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/menu-items/bulk-delete" \  -H "Content-Type: application/json" \  -d '{    "ids": [      0    ]  }'
{  "success": true,  "message": "string"}

Bulk upload menu items from Excel file

POST
/api/menu-items/bulk-upload

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/menu-items/bulk-upload"
{  "success": true,  "message": "string",  "totalProcessed": 0,  "successful": 0,  "failed": 0,  "errors": [    {      "row": 0,      "error": "string",      "data": {        "property1": null,        "property2": null      }    }  ]}

Internal

Previous Page

Notification

Next Page