Antylogic
DemoApp login

399 operational guides

Docs sections
DocsReporting
Device

View the Products Report

Use the Products report to review which products sold in one location during the selected reporting period. The page combines total units sold and money earned with a sold-products table by product name, category, units, revenue per unit, total revenue, and average kitchen time.

In this article

The Products report helps location managers and operations leads understand which menu items are selling and how quickly kitchen-prepared items move through service.

For the GB demo runtime, use Harbor Demo Group and Harbor Soho, and open the report with an explicit period that includes TPV activity, such as 2026-06-02_2026-06-02.

Before you start

  • The operator is signed in and has selected an organisation and location.
  • The operator has location-level access through at least one accepted permission: reports:view, tpv:view, tpv:use, catalog:view, reservation:view, or staff:view.
  • The location exists and has a timezone configured so reporting periods are interpreted correctly.
  • The selected period includes non-cancelled TPV ticket items if the guide needs material sold-products rows.
  • Product categories are shown when sold ticket items resolve to products and product types; otherwise the report falls back to kitchen name or Uncategorised.

Instructions

  1. 1.

    Open the Products report

    Open Reports, then Catalogue, then Products from the side menu, or use the contextual route /:orgId/:locationId/reporting/catalog/products for the selected organisation and location. If no organisation or location is selected, the screen asks the operator to select a location. If the operator lacks the accepted permissions, the report is blocked before dashboard data is requested.

  2. 2.

    Choose the reporting period

    Use the period filter to choose the date range to review. When no periods query is present, the app starts from the current week. Periods are encoded as YYYY-MM-DD_YYYY-MM-DD, and multiple periods are separated with ~. The screen keeps at least one period active and normalises ranges whose end date is earlier than the start date.

  3. 3.

    Review summary totals

    Read the summary card for total units sold and money earned. These totals come from non-cancelled TPV ticket items in the selected location and period. If there is no matching TPV activity, the report can still load, but the sold-products block shows its empty state.

  4. 4.

    Compare sold products

    Use the sold-products table to compare menu items by name, category, units sold, money earned per unit, money earned, and average kitchen time. In the Harbor Soho demo data, product examples include Fish and chips, Beef pie, Cheddar and leek soup, and Sticky toffee pudding when they have sales in the selected period.

  5. 5.

    Search and export visible rows

    Use the table search field to narrow rows by product name. On web, the export menu downloads the currently filtered rows as CSV, Excel, or PNG. On non-web platforms, the app explains that report exports are currently available on web only.

Validations and limits

  • The page is read-only and does not create, edit, or delete products, tickets, or ticket items.
  • GET /api/app/{orgId}/{locationId}/reports is the dashboard source used by this page; the page selects pages.products from the response.
  • Cancelled ticket items are excluded from aggregation, and negative quantities do not reduce units sold.
  • Average kitchen time is calculated only for items that require kitchen handling and have valid production timestamps.
  • The sold-products table search filters only by the first cell, which is the product name.
  • The current screen does not provide row drill-down, interactive sorting, pagination, or product/category/catalogue filters.

Expected result

The operator can review product performance for a selected location and period, compare units and revenue by item, inspect average kitchen time, search by product name, and export the filtered table on web.

Related articles