Foodics

List available loyalty rewards. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

get_loyalty_rewards

List loyalty transactions (the earn/redeem history). Optionally filter by customer or order UUID. For a customer's CURRENT balance, use get_customer_points instead. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

get_loyalty_transactions

Get ONE modifier option by UUID with every relation embedded, including `allergens` and `nutrition_info` — the only tool that returns those (search_modifier_options cannot include them). For other detail prefer search_modifier_options(ids=[...], include=[...]), which takes up to 50 at once. Here every relation is returned, so a missing one means none is set. Rows carry a numeric `costing_method` code — read meta.enums for the labels.

get_modifier_option

Get a single order by UUID. Use include for full detail, e.g. include=["products.product","payments.payment_method","customer","branch"]. Order rows carry numeric `status`, `type`, `source`, `delivery_status` and `discount_type` codes — read meta.enums for the labels (note `order_status` decodes the order's own status, `product_status` decodes each line item's; they are different tables).

get_order

Get ONE product by UUID with every relation embedded, including `allergens` and `nutrition_info` — the only tool that returns those (search_products cannot include them). For other detail prefer search_products(ids=[...], include=[...]), which takes up to 50 at once. Here every relation is returned, so a missing one means none is set. Rows carry numeric `pricing_method`, `selling_method` and `costing_method` codes — read meta.enums for the labels.

get_product

Gift card activity over a date range (issued, redeemed, balances). Use for gift-card liability or redemption reporting.

get_gift_cards_report

Opening stock, closing stock, consumption, and variance per item over a date range. Use for stock reconciliation or shrinkage analysis. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

get_inventory_control_report

Row-level log of every inventory movement (adjustments, transfers, receipts) over a date range. Use when you need the full audit trail of stock changes. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

get_inventory_history_report

Point-in-time stock quantities across branches — no date range required. Use for multi-branch inventory snapshots. For a single branch's live quantities use get_inventory_levels instead. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

get_inventory_levels_report

Menu engineering matrix over a date range — classifies each item as Star / Plow-horse / Puzzle / Dog based on popularity vs profitability. Use for menu optimisation decisions.

get_menu_engineering_report

Live operational snapshot — active orders, free tables, online cashiers, last sync time per branch. No date range, real-time data only.

get_operations_report

High-level KPI over a date range (net sales, order count, avg order price, top products/branches, etc.). Returns ONE KPI per call — the `metric` argument is required; call once per KPI you need. Use as the first stop for 'how are we doing?' questions. Whole-business only — this report accepts NO filters at all (no branches/branch_id); for per-branch figures use a sales_by_* report. There is also no gross_sales metric of any name here (see the `metric` param) — for gross revenue use a sales_by_* report's gross_sales column.

get_overview_report

Payment totals by payment method over a date range. Use when you need to know how much was paid by cash, card, wallet, etc.

get_payments_report

Row-level list of purchase orders over a date range. Use to audit procurement activity or find orders from a specific supplier.

get_purchase_orders_report

Aggregated purchasing summary over a date range, grouped by branch or supplier. Use for spend analysis per supplier or per branch.

get_purchasing_report

Sales totals broken down by branch. Use when comparing branch performance (revenue, orders, discounts, tax). group_by slices each branch row further. IMPORTANT: the branch rows (no group_by, or a time, order-type or staff group_by) INCLUDE paid-modifier revenue and order charges in net_sales. Item group_bys split that money differently: group_by='product' or 'category' rows show the base item price only (no modifier revenue, no charges), group_by='modifier' rows carry the modifier revenue, group_by='combo' rows the combos. This report has no exclude_modifiers parameter, unlike sales_by_product/sales_by_category/sales_by_combo: passing one here is DISCARDED by the API before the query runs (verified live: 200 with unchanged numbers), so do NOT read that 200 as the flag having worked.

get_sales_by_branch_report

Sales totals broken down by cashier (the POS user who rang up the order). Use to evaluate cashier productivity or spot outliers.

get_sales_by_cashier_report

Sales totals broken down by menu category. Use to see which menu sections drive the most revenue. net_sales INCLUDES paid-modifier revenue by default but never order charges: the default total plus sales_by_branch's charges equals sales_by_branch's total. exclude_modifiers=true gives the base item price only, which matches sales_by_branch with group_by='category'.

get_sales_by_category_report

Sales totals broken down by charge type (delivery fee, service charge, etc.). Use to analyse extra-fee revenue.

get_sales_by_charge_report

Sales totals broken down by combo meal. Use to rank combo performance. net_sales INCLUDES paid-modifier revenue by default, which matches sales_by_branch with group_by='combo'; exclude_modifiers=true leaves the modifier revenue out.

get_sales_by_combo_report

Sales totals broken down by order creator (staff member who opened the order, which may differ from the cashier). Use to track order-creation activity per employee.

get_sales_by_creator_report

Sales totals broken down by customer — each row IS one customer (do NOT pass group_by='customer'). Use for top-spender ranking or loyalty-driven revenue breakdown. group_by slices each customer row further (e.g. by branch or product). Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

get_sales_by_customer_report

Sales totals broken down by delivery zone. Use to compare delivery-area revenue and order volumes.

get_sales_by_delivery_zone_report

Sales totals broken down by discount. Use to measure how much each discount drives revenue and how often it's applied.

get_sales_by_discount_report

Sales totals broken down by delivery driver. Use to compare driver performance (orders delivered, revenue carried).

get_sales_by_driver_report

Sales totals broken down by modifier option (e.g. 'Extra cheese'). Use to see which add-ons are most popular and their revenue impact.

get_sales_by_modifier_option_report

Sales totals broken down by order source. Rows carry a numeric `order_source` code — read meta.enums for the labels. Use to compare channel performance.

get_sales_by_order_source_report

Sales totals broken down by order type. Rows carry a numeric `order_type` code — read meta.enums for the labels. Use to compare fulfilment-type revenue.

get_sales_by_order_type_report

Sales totals broken down by product. Use for best/worst seller ranking, product revenue contribution. net_sales INCLUDES paid-modifier revenue by default but never order charges: the default total plus sales_by_branch's charges equals sales_by_branch's total. exclude_modifiers=true gives the base product price only, which matches sales_by_branch with group_by='product'.

get_sales_by_product_report

Sales totals broken down by promotion. Use to measure promotion effectiveness and uplift.

get_sales_by_promotion_report

Sales totals broken down by dining section (floor area / seating zone). Use to compare section utilisation and revenue.

get_sales_by_section_report

Sales totals broken down by table. Use to compare table-level revenue and average covers.

get_sales_by_table_report

Sales totals broken down by timed event (scheduled menu/pricing windows such as happy hour or breakfast). Use to measure event-driven revenue.

get_sales_by_timed_event_report

Search allergens. Filterable by name and predefined flag. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_allergens

Search branches. `name` is free-text (substring match); `reference` is exact. Also filterable by online-order capability. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_branches

Search menu categories. Filterable by name and reference. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_categories

Search combo meals. Filterable by name, category, active status. Set full_detail=true for the whole tree in the same call: sizes, items, their options and products, with the combo prices. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_combos

Search cost adjustment transactions (corrections/overrides to inventory item costs). Filterable by branch, status, reference, business date range. Rows carry a numeric `status` code — read meta.enums for the labels. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_cost_adjustments

Search coupons. Filterable by name, code, discount, active status. Rows carry a numeric `coupon_type` code — read meta.enums for the labels. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — do not summarize, count, chart, or answer from it yet. Call this tool again passing meta.next_starting_page as starting_page to fetch the next batch, and repeat until meta.has_more is false before presenting any answer. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_coupons

Search customers. Filterable by name, email, phone, blacklist status, loyalty membership. Use it to find specific customers, e.g. 'customers named Ahmed' or 'the customer with this phone number', or to rank them with sort_by (e.g. the newest customer, or most orders ever). For a count, pass count_only=true (e.g. 'how many loyalty members do we have': is_loyalty_enabled=true, count_only=true). NOT for totals: top spenders or revenue per customer → get_sales_by_customer_report (e.g. 'top 20 customers this month'); one customer's lifetime spend and visits → get_customer_insights_report. Rows carry a numeric `gender` code — read meta.enums for the labels. Rows are lean: a related object (category, branches, options, …) is present only when named in `include` — a missing key means not requested, not empty. To look up known records by UUID, pass ids=[...] (up to 50, live or deleted) with the include you need, in one call. Returns up to 200 items per call. If meta.has_more is true, THE RESULT IS INCOMPLETE — never present it as complete. Fetch the next batch (pass meta.next_starting_page as starting_page) only when you need the rows themselves; for totals, use the report named above instead of paging to the end. If meta.rate_limited_retry_after is set, the batch stopped at the rate limit: wait that long before fetching the next one.

search_customers