Skip to main content
All tools are scoped to the authenticated account; venueId narrows to one venue on that account and is rejected for any other (NOT_FOUND, or PERMISSION_DENIED from create-payment-link). Every tool returns the { data, meta } envelope; every failure is an isError result.

Shared Inputs

These parameters recur across tools and behave identically everywhere. Every enum below is a fixed list validated by the server; any other value is rejected with INVALID_INPUT. Fulfillment method values, where accepted, are exactly: InStore, Delivery, Pickup, Curbside, Billpay, CateringDelivery, CateringPickup.

Venues

list-venues

Read. Start here: it is how an agent discovers venue IDs. Returns data.results[] of venue summaries: id, name, slug, timezone, currencyCode, address, fulfillment capabilities, openNow (taking orders and within opening hours right now), snoozedUntil and dashboardUrl.

get-venue

Read. Returns the venue with address, opening hours per fulfillment method, prep times, delivery fees and service charges.

snooze-venue

Write. readOnlyHint: false, idempotentHint: false. Closes the whole store to new orders until the specified time; pre-orders may continue if that setting is enabled. Returns the venue ID, name, snooze end time, reason and enabled status.

unsnooze-venue

Write. readOnlyHint: false, idempotentHint: true. Reopens a whole store early; if it is not snoozed, no change is made. Returns the venue ID, whether it was snoozed and, when reopened, the reopening time.

get-integrations

Read. For each store: which POS, delivery, loyalty and other integrations are set up, what each is linked to, key settings, whether the account-level connection is set up, when each menu last synced, and the latest POS error from the last 14 days with guidance. Never returns credentials.

list-tables

Read. Lists dine-in tables at one venue; non-archived tables are included by default, including inactive ones. Returns data.results[] with each table’s id, name, nullable area, active and archived fields.

Orders

list-orders

Read. Rejected and cancelled orders are excluded unless selected with status. pagination.total may be an estimate; page on hasMore. Each order row includes table as id, name and nullable area, or null when no table is associated.

get-order

Read. Returns line items with modifiers, price breakdown (subtotal, delivery fee, service charge, tip, discount), tax lines when the venue configures taxes, customer, table/area, delivery address, refund history and, when the order failed to reach the POS, the POS error with guidance.

get-order-events

Read. The order’s lifecycle audit trail: status changes, POS dispatch results, delivery updates.

list-menus

Read. Returns menus with venue assignment and active/archived status.

get-menu

Read. Returns categories with display order, and products with PLU/SKU, prices, availability, inventory tracking, tags and modifier groups. Not paginated.

update-menu-items

Write. readOnlyHint: false, idempotentHint: true. Edits a menu item’s name, description or popular flag. Read get-menu first: every change carries the current value as expected, and a stale expected refuses that item’s whole patch. Returns one result per item with outcome (updated, unchanged or refused), a reason, the before/after values and the affected menu IDs. Text owned by the POS is refused, and translations are not changed (translationsStale says when they are now out of date). A cache_refresh_failed warning means the edit was saved but has not reached every surface yet; read again rather than retrying.

Snoozing

get-snooze-report

Read. Snoozes that overlap the interval. The summary and time series cover the whole interval; items are paginated.

list-snoozed-items

Read. Lists menu items that are currently snoozed, ordered by when the snooze ends. Returns data.results[] with each item’s menu item ID and name, PLU, venue ID, snooze start and end.

snooze-menu-items

Write. readOnlyHint: false, idempotentHint: false. Hides one or more menu items from ordering until the specified time, replacing any existing snooze on those items. Returns the venue ID and the snoozed items with their IDs, names, venue IDs and start/end times.

unsnooze-menu-items

Write. readOnlyHint: false, idempotentHint: true. Clears snoozes so menu items can be ordered again. Returns each item ID and name, and whether it was snoozed.

snooze-menu-categories

Write. readOnlyHint: false, idempotentHint: false. Hides every item in whole menu categories until the specified time, at the venue the menu belongs to, replacing any existing category snooze.

unsnooze-menu-categories

Write. readOnlyHint: false, idempotentHint: true. Clears category snoozes. Categories that were not snoozed are reported with wasSnoozed: false; a category with a future availableAfter only becomes orderable from that time.

Stats

get-order-stats

Read. Order count, sum of order totals and average order value by order creation time, alongside a comparison period: the same dates a week earlier for 2–6 dates (so weekdays line up), otherwise the equal-length period just before. Totals exclude rejected/cancelled orders and are not net of refunds (a meta.warnings entry says so). On an account whose venues use more than one currency, venueId is required (INVALID_INPUT).

list-top-products

Read. Products ranked by quantity sold, by order creation time. Prices are current catalogue prices, not historical selling prices. Multi-currency accounts must pass venueId.

get-end-of-day-report

Read. Daily takings matching the dashboard Z-Report: online orders only, not pay-at-table bills. Gross sales include rejected and cancelled orders, unlike get-order-stats, and refunds count on the refund date. Multi-currency accounts must pass venueId.

get-app-audience

Read. App downloads in the period (installations registered) and current push subscribers, matching the cards on the app Audience report. Account-wide. pushSubscribers is the current total, whatever the dates.

list-report-fields

Read. Lists the reporting views behind the dashboard’s analytics and, with view, that view’s measures, dimensions and worked examples. Call it before run-report.

run-report

Read. A paginated aggregate report on one view from list-report-fields. When no rollup exists for the requested timezone the report runs in UTC and meta.warnings says so.

Discounts

list-discount-codes

Read. Returns code, type, amount, usage stats and validity dates.

create-discount-code

Write. readOnlyHint: false, idempotentHint: false. The code must be unique per venue (CONFLICT otherwise) and is stored lowercased. Returns the created discount code in data.

update-discount-code

Write. readOnlyHint: false, idempotentHint: false. Edits an existing code; only the fields you pass change. Changing a code’s type to buyonegetonefree is refused, because those codes need product limits this tool cannot set.

Refunds

list-refunds

Read. Successful refunds only.

Payments

list-transactions

Read. Individual card payments and refunds, matching the dashboard All Transactions report. storekit payments only; pending payments are excluded and refunds have negative amounts.

get-payouts

Read. Live storekit payments balances, payout schedule and up to 10 recent bank transfers from the last 30 days. A scheduled payout is not a bank arrival; only booked transfers count as paid out.

Pay at Table

list-bills

Read. Bills by creation time. Returns status, currency, total, amount due, covers and table name.

Feedback & Reviews

list-feedback

Read. Lists completed storekit feedback (ratings and comments left after an online order or pay-at-table bill), newest first. Defaults to the last 30 local dates and feedback with written overall or item-level detail. Returns feedback rows with ID, venue, rating, comment, creation time, source, order or bill ID, customer email and item feedback (name, rating, sentiment, reasons, comment, quantity and modifiers).

list-reviews

Read. Lists public Google reviews, newest first, with our reply when one was sent. Returns review rows with reviewer name, rating, comment, creation time and reply (comment, at, source) or null.

get-feedback-summary

Read. Summarises storekit feedback and Google reviews for a period against the preceding period of the same length. Defaults to the last 30 local dates; not paginated. Returns storekit review counts, averages, 1–5 rating breakdown, low-rating share and completion rate; google review counts, averages, low-rating and unreplied counts, storekit-attributed reviews, current rating/total and changes (or null when there is no Google data); items with most complained/praised items and top reasons plus reason totals; venues worst first for account-wide calls (up to 25, with a meta.warnings entry if capped); and up to three low- and high-rated recent feedback quotes, including customer email. Items are grouped by name across venues. Google ratings are daily snapshots: a past period uses the last full UTC day that ended before the period ended, while a period that includes today uses today’s live rating.

Customers

search-customers

Read. Searches account customers by email, first or last name, or phone. Order totals cover the last 24 months. Returns matching customers’ email, name, phone, order count, 24-month order value in minor currency units, last order date and marketing opt-in status.

get-customer

Read. Returns a customer profile with contact, order, app, loyalty, recent-order and insight data. Returns customer contact and order totals, app and loyalty data, up to 10 recent orders, and customer insights when available. Read. Returns link details with payment stats. Read. Write. readOnlyHint: false, idempotentHint: false. The link is active as soon as it is created. Returns the created link in data. Fires the payment_link.created webhook when the account has webhooks enabled. Read. The only tool that returns an image. The result carries the checkout metadata in structuredContent (and the JSON text block) plus a native MCP image/png content block. There is no base64 field inside data.