Fodista Public APIs
  1. Public Menu
Fodista Public APIs
  • 👋 Introduction
  • 📋 Prerequisites
  • ⚠️ Disclaimer
  • Invoice History
    • Retrieve POS invoice history
      GET
  • Public Menu
    • List menu categories
      GET
    • List menu products
      GET
    • Fetch a single menu product
      GET
  • Online Ordering
    • Retrieve the assigned online store
      GET
    • Add a menu product to the cart
      POST
    • Update a cart item
      PUT
    • Remove menu products from the cart
      POST
    • Get cart totals
      GET
    • Get cart details
      GET
    • Update cart details
      PUT
    • Get address from coordinates
      GET
    • Checkout
      POST
    • List currently online branches
      GET
  • POS Ordering
    • Submit POS orders
      POST
  • General
    • Get External Job status
      GET
  • Schemas
    • Schemas
    • ErrorResponse
    • InvoiceTax
    • InvoiceSummary
    • CartTotals
    • CartModifier
    • CartItem
    • CartItemRequest
    • CartModifierRequest
    • CartSummary
    • CustomerPayload
    • MenuProductOrderType
    • MenuProductOptionCombination
    • MenuProductOptions
    • MenuProductModifierSettings
    • MenuProductModifierOption
    • MenuProductModifier
    • MenuProduct
    • MenuCategory
    • PosOrderRequest
    • PosOrder
    • PosOrderItem
    • PosOrderModifier
    • PosOrderTax
    • PosOrderPayment
    • PosOrderSubmitResponse
    • ExternalJobStatusResponse
  1. Public Menu

Fetch a single menu product

GET
/api/method/public/public-menu/menu-product/get
Retrieves the full definition of one menu product, including options and modifier groups. Visibility is enforced automatically: tokens with only the Online Ordering scope receive the online catalogue.

Request

Authorization
Add parameter in header
X-Access-Token
Example:
X-Access-Token: ********************
Query Params

Responses

🟢200OK
application/json
Menu product definition.
Body

🟠401Unauthorized
🟠403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/method/public/public-menu/menu-product/get?menu_product&visibility' \
--header 'X-Access-Token: <api-key>'
Response Response Example
200 - Success
{
    "message": {
        "name": "MP0375",
        "rate": 0,
        "title": "كريبسي",
        "item_code": "MP0375",
        "show_pending_count": 0,
        "description": null,
        "preparation_time_minutes": 15,
        "menu": "MEN0001",
        "currency": "EGP",
        "menu_category": "BAKERY",
        "image": null,
        "parent_product": null,
        "has_options": 1,
        "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,
        "options": {
            "attributes": [
                "Size"
            ],
            "combinations": [
                {
                    "allow_sales_limit": 0,
                    "name": "MP0375-5 قطع",
                    "rate": 10,
                    "Size": "5 قطع",
                    "balance": 10000,
                    "sales_limit": 10000
                },
                {
                    "allow_sales_limit": 0,
                    "name": "MP0375-4 قطع",
                    "rate": 0,
                    "Size": "4 قطع",
                    "balance": 10000,
                    "sales_limit": 10000
                },
                {
                    "allow_sales_limit": 0,
                    "name": "MP0375-6 قطع",
                    "rate": 0,
                    "Size": "6 قطع",
                    "balance": 10000,
                    "sales_limit": 10000
                },
                {
                    "allow_sales_limit": 0,
                    "name": "MP0375-3 قطع",
                    "rate": 0,
                    "Size": "3 قطع",
                    "balance": 10000,
                    "sales_limit": 10000
                }
            ]
        },
        "modifiers": [
            {
                "title": "Extras",
                "name": "Extras",
                "settings": {
                    "minimum_qty": 0,
                    "maximum_qty": 1000,
                    "sequence_id": 50,
                    "collapsed": 1
                },
                "options": [
                    {
                        "name": "MP0205",
                        "group": "Extras",
                        "title_at_frontend": "Extras",
                        "title": "WHITE SOURDOUGH BREAD",
                        "pos_display_name": null,
                        "enabled": 1,
                        "rate": 0,
                        "allow_sales_limit": 0,
                        "apply_qty_limit": 0,
                        "min_qty": 0,
                        "max_qty": 1000,
                        "idx": 1,
                        "balance": 10000,
                        "sales_limit": 10000
                    },
                    {
                        "name": "MP0208",
                        "group": "Extras",
                        "title_at_frontend": "Extras",
                        "title": "TORTELLA BREAD",
                        "pos_display_name": null,
                        "enabled": 1,
                        "rate": 0,
                        "allow_sales_limit": 0,
                        "apply_qty_limit": 0,
                        "min_qty": 0,
                        "max_qty": 1000,
                        "idx": 3,
                        "balance": 10000,
                        "sales_limit": 10000
                    }
                ]
            },
            {
                "title": "FF5",
                "name": "FF5",
                "settings": {
                    "minimum_qty": 0,
                    "maximum_qty": 1000,
                    "sequence_id": 50,
                    "collapsed": 0
                },
                "options": [
                    {
                        "name": "MP0206",
                        "group": "FF5",
                        "title_at_frontend": null,
                        "title": "WHITE BAGGET BREAD",
                        "pos_display_name": null,
                        "enabled": 1,
                        "rate": 0,
                        "allow_sales_limit": 1,
                        "apply_qty_limit": 0,
                        "min_qty": 0,
                        "max_qty": 1000,
                        "idx": 2,
                        "balance": 10000,
                        "sales_limit": 10000
                    },
                    {
                        "name": "MP0221",
                        "group": "FF5",
                        "title_at_frontend": null,
                        "title": "Potato Wedges",
                        "pos_display_name": null,
                        "enabled": 1,
                        "rate": 0,
                        "allow_sales_limit": 1,
                        "apply_qty_limit": 0,
                        "min_qty": 0,
                        "max_qty": 1000,
                        "idx": 4,
                        "balance": 10000,
                        "sales_limit": 10000
                    }
                ]
            }
        ],
        "shortcuts": [],
        "qty_shortcuts": [],
        "order_types": [
            {
                "name": "Dine In"
            },
            {
                "name": "Delivery"
            },
            {
                "name": "Reservations"
            },
            {
                "name": "Takeaway"
            }
        ],
        "defaults": {},
        "balance": 10000,
        "sales_limit": 10000,
        "pending_count": 0
    }
}
Previous
List menu products
Next
Retrieve the assigned online store
Built with