List menu products

GET

/api/method/public/public-menu/menu-product/all

Returns every menu product that is visible for the configured branch or brand. Use optional filters to evaluate availability for specific order types. Tokens that only have the Online Ordering scope must request visibility=online.

Request

Authorization

Add parameter in header

X-Access-Token

Example:

X-Access-Token: ********************

Query Params

Responses

🟢200OK

application/json

Array of menu products with pricing, modifiers and availability info.

Body

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/method/public/public-menu/menu-product/all?order_types&visibility' \
--header 'X-Access-Token: <api-key>'

Response Example

200 - Success

{
    "message": [
        {
            "name": "MP0014",
            "rate": 50,
            "title": "Extra Matcha",
            "item_code": "MP0014",
            "show_pending_count": 0,
            "description": null,
            "preparation_time_minutes": 15,
            "menu": "MEN0001",
            "currency": "EGP",
            "menu_category": "Extras",
            "image": null,
            "parent_product": null,
            "has_options": 0,
            "include_in_all_order_types": 0,
            "must_be_whole_number": 0,
            "sell_by_barcode": 0,
            "barcode_required_for_selling": 0,
            "barcode_configuration": null,
            "sell_by_amount": 0,
            "allow_sales_limit": 0,
            "order_types": [
                {
                    "name": "Delivery"
                },
                {
                    "name": "Dine In"
                },
                {
                    "name": "Takeaway"
                }
            ],
            "price_list": "7vlfb7afnd",
            "priority": 10,
            "balance": 10000,
            "sales_limit": 10000,
            "pending_count": 0
        }
    ]
}

List menu categories

Fetch a single menu product