Brainerce

Average order value for the period. Read-only.

get_average_order_value

Get one customer by id, including addresses, tags, order count, total spent, and platform connections.

get_customer

List a customer orders (paginated summaries; download details are reduced to a hasDownloads flag).

get_customer_orders

Get a single order by id with full detail (items, totals, payment, refunds, addresses, status label). Read-only.

get_order

Order count and percentage grouped by status (status donut). Read-only.

get_orders_by_status

Order count, returns count, and total amount for a period or custom date range. Read-only.

get_orders_stats

Get one product by id with full details (variants, inventory, attributes, metafields, categories/brands/tags, images, channels, modifier groups, availability windows, SEO score). Pass regionId to include region display prices. The top-level `inventory` is the authoritative stock total (already summed across variants for VARIABLE products) — use it directly rather than adding up `variants[].inventory` yourself.

get_product

Get inventory state for one product (tracking mode, total, reserved, available, inStock, canPurchase). storeId-fenced. ⛔ Returns null for a KIT, and that is not "no stock": a kit owns no inventory row at all, and how many can be sold is derived from its contents. Read that with get_kit_components (its `available` field), which needs the `products:read` scope rather than `inventory:read`.

get_product_inventory

Get one metafield value on a product (optionally variant-scoped).

get_product_metafield

Get aggregate review stats for a product. `total`, `avgRating` and `distribution` (1-5) are computed over NON-HIDDEN reviews, the same predicate behind Product.avgRating, so they never contradict the rating shown elsewhere for that product. Also returns `hidden` (reviews taken down), `withPhotos`, and `pendingPhotos` — counted over PHOTOS awaiting approval, not reviews, since one review can hold up to five.

get_product_review_stats

Most recent orders as a compact list (order number, customer, total, status, date). Read-only. Bounded to 100.

get_recent_orders

Fetch the store profile and settings: name, currency, language(s), country, plan, status, tax config, branding (colors/logo), contact info, social links, timezone, enabled modules, and lifecycle timestamps. `scheduledDeletionAt` is the last day the owner can reactivate a suspended store themselves, NOT a date on which data is erased — nothing is erased. Read-only.

get_store

Whole-store KPI snapshot: product counts, order counts (today/week/month/pending-fulfillment), and revenue (today/week/month, plus the same point last month for comparison). Also returns a 30-day daily revenue and order series, which the card charts. Read-only.

get_store_analytics_summary

Top-selling products by quantity or revenue (with cost/profit/margin where cost price is set). Read-only. Limit capped at 20.

get_top_selling_products

List the store's categories as entities (not product assignments) with pagination. Filter by search/active/platform. Returns the standard { data, meta } page. Each row includes parentId (hierarchy), image, taxBehavior and product counts. Use this to enumerate the taxonomy before editing or assigning.

list_categories

List/search coupons for the store with pagination. Filter by free-text (code/title/description), status, type, or platform. Returns code, type, value, usage limits/count, date window, applicable/excluded products & categories (resolved to names), and channel publishes.

list_coupons

List, search, and SEGMENT customers for the store with pagination. Filters (all DB-side): free-text search (email/name/phone), account vs guest, marketing opt-in, geography (country ISO-2 + state/region), lifetime-spend range, order-count range, recency (ordered within N days) and lapsed (no order in N+ days). Optional store-relative RFM scoring (quintiles + champion/loyal/new/at-risk/hibernating labels). Returns summaries with order count and total spent.

list_customers

List/search automatic discount rules for the store with pagination. Filter by free-text (name/description), type, and enabled state. Returns priority, type, config, combination flags, usage stats, and channel scoping.

list_discount_rules

List orders for the store, newest first. Supports search (matches external order id), status filter, and sort. Read-only; returns a paginated page of order summaries.

list_orders

List all metafield values set on a product (with their definitions).

list_product_metafields

List reviews for a product (admin moderation view), page-based. Includes author email, order id, and every photo the reviewer attached in `images` — including ones hidden or still awaiting approval, which shoppers never see. Each image carries `id` (pass it to hide_review_photo / show_review_photo), `url`, `approvedAt` (null = waiting on the merchant) and `hiddenAt`. Filters: `visibility` (visible/hidden/all) is about the REVIEW; `pendingPhotos` is the only way to find a photo still waiting on the merchant, because that photo sits inside a review that is itself VISIBLE and no `visibility` value reaches it. Also `hasPhotos`, `rating` (exact 1-5), and `sort` — use `lowest` to triage complaints first rather than reading eighty reviews newest-first.

list_product_reviews

⛔ NOT for counting. To answer 'how many products do I have', call get_store_analytics_summary (or count_products) — do NOT fetch a page here just to read meta.total: this tool renders a product CARD, so a one-row page shows the merchant ONE product beside your sentence saying seven. List products with pagination, search and filters (status, type, category/brand/tag names, sales channel, downloadable, has-images, locale, region for FX-overlaid display prices). Returns the standard { data, meta } page. Use this to find product ids before reading or editing. Each product's `inventory` field is the authoritative stock total — for VARIABLE products it is already summed across all variants, so use it directly rather than adding up `variants[].inventory` yourself. Pass layout: 'list' when the user asks for a list or table view.

list_products

List all sales channels (vibe-coded storefront connections) for the store, including mode (TEST/LIVE), status, domain, enabled flag, and connection id. Use to see which storefronts are connected before publishing products or coupons. Channel count is bounded by the store plan limit (small list, not paginated).

list_sales_channels

List the store's tags as entities (not product assignments) with pagination. Filter by search/active/platform and scope (product vs customer tags). Returns the standard { data, meta } page with product counts. Use this to audit the tag vocabulary before cleaning it up.

list_tags

PREVIEW only — estimate the discount a coupon would apply to a hypothetical order. Validates status/window/usage-limit/minimum-order/applicable-products and computes a discount preview from server-side catalog prices. It does NOT redeem the coupon or increment its usage; actual redemption happens only at checkout. Use it to show an estimate, never to apply a discount. NOTE: the server recomputes subtotal from catalog; client-supplied price/subtotal are ignored (included only for DTO compatibility).

preview_coupon_for_order

Set (upsert) a metafield value on a product (or a specific variant). Value is validated against the definition type. Enqueues channel sync.

set_product_metafield

Set the absolute total stock for a SIMPLE product (Redis-locked, storeId-fenced, writes an audit log; emits inventory events). Use set_variant_stock for variant products.

set_product_stock

Enable or disable a discount rule without editing its config.

toggle_discount_rule

Change an order's status (state-machine enforced; illegal transitions rejected). Triggers a customer email: moving to SHIPPED sends a shipped email, to CANCELLED a cancellation email, to COMPLETED/DELIVERED a completion email (with digital download links) — these are unconditional on this path. Enforces pay-before-ship and pay-before-PAID gates. Optionally sets a custom status label.

update_order_status

Update fields on an existing product (partial). Omitted fields are unchanged. Can change name/slug/prices/status/SKU/descriptions/tax-class/shipping-class/categories/tags/metaDescription/menuOrder. Assign categories/brands by existing ID (replaces the set) or by name with auto-create (categoryNames/brandNames, additive). Enqueues channel-aware sync. Passing images REPLACES the whole array; externally-hosted ones are queued for download and stay invisible on the storefront until that completes. The response echoes each image importStatus (pending / failed, with importError when it failed) — read it rather than assuming a successful write means a live image.

update_product