get_shipment_system_log
Fetch the full details of a specific system log entry for a shipment, including the complete request and response bodies.
The drill-down companion to
list_shipment_system_logs —
get the identifier from the list call, then call this tool for the
full payload.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | The tenant. |
shipment_id | string | Yes | Carriyo shipment ID. |
identifier | string | Yes | Unique log identifier from list_shipment_system_logs. |
Returns
A single log entry with the full request body sent to the carrier (or to the Carriyo subsystem) and the full response body received, plus all the metadata from the list-call.
Example agent prompt
"Show me the full body of log entry abc-123 for SHP-12345."
get_shipment_system_log(
tenantId="…",
shipment_id="SHP-12345",
identifier="abc-123"
)
The agent reads the response body, identifies the carrier's error message, and narrates the cause — for example: "Aramex returned a 500 saying the address is not deliverable. Looks like the postcode isn't recognised."
Common chain
Diagnose a stuck shipment —
the canonical multi-tool flow. After
list_shipment_system_logs(responseCode="5xx") returns errors, this
tool fetches the full body for the most-recent failure so the agent
can interpret it.
Related tools
list_shipment_system_logs— the catalog. Always call this first to get a valid identifier.
Notes
- Bodies can be large. The agent should usually summarise the response rather than echoing it verbatim.
- Sensitive data (carrier credentials, customer PII) may appear in these payloads. In customer-facing agents, restrict this tool via the agent client (see Limits & security → tool-catalog restriction).