report_product_performance

SKU-level product movement metrics with pagination, totals, and optional CSV export controls.

The right tool when the question is "which SKUs ship the most?" or "what's the return rate for SKU X?" — not just shipment-level data.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant to report on.
from	string	Yes	Range start.
to	string	Yes	Range end.
merchant	string | string[]	No	Restrict to one or more merchants.
page, page_size	number	No	Pagination — useful for catalogs with many SKUs.
sort_by, sort_direction	—	No	Sort the SKU list (e.g. by shipped quantity desc).
select	string	No	json-mask — useful when only totals are needed.

Returns

• Totals — aggregate movement across the date range.
• Per-SKU rows — paginated, sortable.
• (Server may also support an export-controlled CSV variant — inspect the response shape.)

Example agent prompts

"Which SKUs shipped the most last month?"

report_product_performance(
  tenantId="…",
  from="2026-04-01",
  to="2026-04-30",
  sort_by="shipped_quantity",
  sort_direction="desc",
  page_size=20
)

"Show me totals for SKU movement across all merchants this quarter."

report_product_performance(
  tenantId="…",
  from="2026-02-01",
  to="2026-04-30",
  select="totals"
)

Related tools

• report_return_analytics — return-side view, including item-level top products.
• get_shipment_list (with item filters) — drill into shipments for a specific SKU.

Equivalent in the dashboard

Reports → Product Performance.

Notes

• For large catalogs, paginate (page, page_size). The agent should never fetch unbounded SKU lists into context.
• select="totals" skips the per-SKU rows entirely — useful for a one-line summary in chat.