get_shipment_activity

Updated May 19, 20261 min read

Activity timeline for a shipment, including creation, status changes, rule assignments, notifications sent, and customer feedback.

This is the Carriyo-internal view of the shipment's history. Pair it with list_shipment_system_logs for the carrier-side view.

Parameters

NameTypeRequiredDescription
tenantIdstringYesThe tenant.
shipment_idstringYesCarriyo shipment ID or partner_shipment_reference.
merchantstringNoOptional merchant filter when the same reference could resolve ambiguously.
selectstringNojson-mask expression to filter response fields.

Returns

A timeline of activity entries. Each entry typically has a type (status_change, rule_assignment, notification, feedback), a timestamp, and a payload describing what happened.

ToolShows
get_shipment_activityCarriyo-internal events (status changes, rule fires, notifications, feedback).
list_shipment_system_logsCarrier-side requests / responses.
get_shipmentCurrent state, no history.

For diagnosing what went wrong, you typically want both activity and system logs.

Example agent prompts

"What's happened to SHP-12345 since it was created?"

get_shipment_activity(
  tenantId="…",
  shipment_id="SHP-12345"
)

"Just show me the notifications that were sent."

get_shipment_activity(
  tenantId="…",
  shipment_id="SHP-12345",
  select="activity(type,timestamp,payload).filter(type=='notification')"
)

Common chain

Diagnose a stuck shipment — the canonical multi-tool flow that reads activity for the Carriyo-side picture and system logs for the carrier-side picture.