report_shipment_status_summary

Aggregated shipment counts by current status, with optional subgrouping. Useful for a filtered operational snapshot rather than a single shipment lookup.

Parameters

Name	Type	Required	Description
tenantId	string	Yes	The tenant to report on.
select	string	No	json-mask syntax to trim the response.
merchant	string | string[]	No	Restrict to one or more merchants.
location_access	string | string[]	No	Restrict by accessible location ids.
country_access	string | string[]	No	Restrict by country code.
shipment_type	string	No	forward or reverse — defaults to forward.
milestone	string	No	Filter by milestone (e.g. created, booked, shipped).
sub_group_by	string	No	Add a second dimension to the breakdown (e.g. by carrier within each status).
tzoffset	string	No	Timezone offset for date calculations.

This tool also accepts the broad shipment-filter set (carrier, status, date ranges, custom-attribute filters) used elsewhere — see get_shipment_list for the full list, which it shares.

Returns

A counts-by-status object. With sub_group_by, each status bucket contains a nested breakdown by the requested dimension.

Example agent prompts

"How many shipments are currently in each status?"

report_shipment_status_summary(tenantId="…")

"Show me the status breakdown by carrier for last week's reverse shipments."

report_shipment_status_summary(
  tenantId="…",
  shipment_type="reverse",
  sub_group_by="carrier",
  creation_date_from="…",
  creation_date_to="…"
)

Related tools

• report_dashboard_summary — fixed 30-day operational snapshot; broader than just status counts.
• report_shipment_volume_trend — trend over time rather than current snapshot.
• report_shipment_ageing — same data, sliced by how long shipments have been in each state.

Equivalent in the dashboard

Reports → Shipment Status Summary.