Docs
Sign in

System logs tools

Updated May 9, 20261 min read

2 diagnostic tools. They surface a shipment's interaction history with the underlying carrier and Carriyo subsystems — request type, response code, event type, timestamps, and the full request / response body for any individual log entry.

This is the right family when an agent is asked "why did this happen?" and the answer requires looking at carrier responses or Carriyo system events.

Tools

ToolWhat it returns
list_shipment_system_logsPaginated log entries for a shipment. Each entry has metadata (event type, request type, response code, timestamps, correlation id). Required: tenantId, shipment_id.
get_shipment_system_logThe full request / response body and details for a specific log entry. Required: tenantId, shipment_id, identifier.

Filtering list_shipment_system_logs

Optional filters on list_shipment_system_logs:

  • correlationId — filter to a single correlation chain.
  • carrierId — only logs for one carrier.
  • eventType — e.g. label generation, status update, manifest event.
  • requestType — e.g. create, status, label, cancel.
  • responseCode — narrow to errors (4xx, 5xx) or success (2xx).
  • pageNum, rowsPerPage — pagination.

When agents use these

Diagnose a stuck shipment. Pair with get_shipment and get_shipment_activity (which shows Carriyo-internal events) to get the carrier-side picture:

get_shipment(tenantId="…", shipment_id="…")
get_shipment_activity(tenantId="…", shipment_id="…")
list_shipment_system_logs(tenantId="…", shipment_id="…", responseCode="5xx")
get_shipment_system_log(tenantId="…", shipment_id="…", identifier="…")

The agent reads the failed response body, narrates the cause in plain English, and recommends the next action (reprocess_shipment / reassign_shipment / a label refresh).

See Diagnose a stuck shipment for a full walkthrough.

Notes

  • System logs are diagnostic, not user-facing. Don't return raw log bodies to an end customer — narrate the cause instead.
  • Logs include carrier API responses, which can contain carrier reference numbers, error codes, and address normalisation hints. Useful raw material for an agent's diagnosis.