List Order System Logs

Returns a paginated list of system log entries for the order. Filter by correlation id, event type, request type, or HTTP response code.

SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
reference
required
string

The order reference (order_id or partner_order_reference based on the key parameter).

query Parameters
key
string
Default: "order_id"

Specifies which reference type reference uses.

Enum: "order_id" "partner_order_reference"
correlation_id
string

Filter by correlation id.

event_type
string

Filter by event type (e.g. INBOUND, OUTBOUND, INTERNAL).

request_type
string

Filter by Carriyo request type (see RequestType in platform logging — e.g. ORDER_CREATE, SHIPMENT_CREATE).

response_code
string

Filter by HTTP response status code recorded on the log (e.g. 200).

page_num
integer
Default: 1

Page number (1-based).

rows_per_page
integer
Default: 10

Page size.

header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

tenant-id
required
string

Your unique tenant identifier in Carriyo.

Content-Type
string
Default: application/json
Responses
200

Paginated system logs.

404

Order not found.

get/orders/{reference}/system-logs
Request samples 
Response samples 
application/json
{
  • "total": 0,
  • "page_num": 0,
  • "rows_per_page": 0,
  • "items": [
    ]
}