list_shipment_system_logs
Updated May 19, 20261 min read
List system logs for a shipment. Returns paginated log entries with metadata — event type, request type, response code, timestamps, correlation id.
Use this to find the right log entry. Then call
get_shipment_system_log
to fetch the full request / response body.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | The tenant. |
shipment_id | string | Yes | Carriyo shipment ID. |
select | string | No | json-mask expression to filter response fields. |
correlationId | string | No | Filter to a single correlation chain. |
carrierId | string | No | Filter to one carrier. |
eventType | string | No | Filter by event type. |
requestType | string | No | Filter by request type (e.g. create, status, label, cancel). |
responseCode | string | No | Filter by HTTP response code (e.g. 5xx for errors). |
pageNum | integer | No | Page number. Defaults to 1. |
rowsPerPage | integer | No | Rows per page. Defaults to 10. |
Returns
Paginated array of log entry metadata. Each entry has an
identifier you'll pass to get_shipment_system_log for the full
body.
Example agent prompts
"Find errors in the system logs for SHP-12345."
list_shipment_system_logs(
tenantId="…",
shipment_id="SHP-12345",
responseCode="5xx"
)
"What was the most recent label-generation request for SHP-12345?"
list_shipment_system_logs(
tenantId="…",
shipment_id="SHP-12345",
requestType="label",
rowsPerPage=1
)
Common chain
Diagnose a stuck shipment — the canonical multi-tool flow. List system logs to find errors, then get the full body of the relevant entry.
Related tools
get_shipment_system_log— fetch the full request / response for one entry.get_shipment_activity— the Carriyo-internal activity timeline (status changes, rules, notifications). Pair this with system logs for the carrier-side picture.
Notes
- Logs are diagnostic. Don't surface raw log bodies to end customers — narrate the cause instead.
- Filter aggressively. A busy shipment can accumulate dozens of log entries; the agent rarely needs all of them.