Sales by hour. Sales by channel. Sales by product. Live intraday. Cash reconciliation. Exception reports. The same data that powers the Portal dashboards, available as JSON, on trading-day ranges, ready to stream into your BI stack.
Trading days, not calendar days. What your store counts as “today” is what the API counts as today.
Metrics are aggregates — revenue, order count, AOV, service times — grouped by day, hour, channel, location or product. Reports are the operational outputs — sales summaries, cash breakdowns, exception lists, product mix. Both accept a trading-day range: either two explicit dates or a named range like Last7Days.
Use one of these in place of explicit FirstTradingDay/LastTradingDay parameters. Resolved server-side against the location’s own trading-day cutover time.
Live wallboard numbers. Yesterday’s sales by hour. Channel mix. 产品 mix. Cash reconciliation. A nightly export to your data warehouse.
Real-time revenue, order count and AOV for a single location — updates every second. Drive an in-store dashboard or an above-store group view.
PROTECT_BLOCK_7_ENDResponse — 200 OK
PROTECT_BLOCK_8_END
Classic intraday chart data. Returns one row per hour for the trading day with revenue, order count and AOV. Swap Yesterday for Today or Last7Days as needed.
PROTECT_BLOCK_12_ENDResponse — 200 OK
PROTECT_BLOCK_13_END
How much is Web doing vs in-store vs Uber Eats vs Deliveroo, across every location in a group? Pass a LocationGroups filter instead of explicit locations.
PROTECT_BLOCK_15_ENDResponse — 200 OK
PROTECT_BLOCK_16_END
Which items, modifiers and deals actually sold. Use this to feed forecasting, to rank top-movers by site, or to flag SKUs with unusually low attachment rates.
PROTECT_BLOCK_17_ENDResponse — 200 OK
PROTECT_BLOCK_18_END
What was taken, in what tender, by which till, for a given trading day. Feeds into your accounting system alongside bank settlement.
PROTECT_BLOCK_19_ENDResponse — 200 OK
PROTECT_BLOCK_20_END
The common pattern — a scheduled job pulls yesterday’s trading day across every location, flattens to rows, writes to your warehouse or BI tool (BigQuery, Snowflake, Power BI, Fabric). Pseudo-code sketch:
PROTECT_BLOCK_21_END
Behind the scenes, some reports read the Portal projection store (near-real-time, event-sourced), some read the AMS data warehouse (daily-settled), and some read the legacy dashboard store. The API surface hides the difference. If your data needs to reconcile to bank settlement, prefer the cash-reconciliation and sales-by-* endpoints and wait 24 hours after trading-day cutover.
Auth, environments, your first API call.
产品s, modifiers, prices, allergens, deals.
Live 订单, history, refunds, webhooks.
Profiles, loyalty progress, marketing segments.
Couriers, payment devices, third-party integrators.
API surface, auth, the platform at a glance.
Test environment, sandbox tenant, sample data, real endpoints. No commitment.