Add Order System Log

Records a system log entry for the order (e.g., outbound API call details). Carriyo sets entity_id to the order id from the resolved order.

Typically used for debugging, support, or auditing integration traffic associated with this order.

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"

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

Request Body schema: application/json
required

entity_id	string
entity_ids	Array of strings
carrier_id	string
webhook_id	string
tenant	string
correlation_id	string
event_type	string One of `INBOUND`, `INTERNAL`, `OUTBOUND`. Enum: "INBOUND" "INTERNAL" "OUTBOUND"
request_type	string Carriyo `RequestType` enum name (e.g. `ORDER_CREATE`, `SHIPMENT_CREATE`, `SHIPMENT_HANDLER_TRACK`).
source_type	string
source_id	string
request_time	integer <int64>
request_method	string
request_url	string
	object
request_body	string
raw_request_body	string
response_time	integer <int64>
	object
response_code	integer
response_body	string
	object (Call Statistics) Fine-grained HTTP client phase timestamps (strings, implementation-defined format).
	object (Duration Statistics)

Responses

200

System log created.

400

Invalid request.

404

Order not found.

post/orders/{reference}/system-logs

Request samples

application/json

{"entity_id": "string",
"entity_ids": ["string"
],
"carrier_id": "string",
"webhook_id": "string",
"tenant": "string",
"correlation_id": "string",
"event_type": "INBOUND",
"request_type": "string",
"source_type": "string",
"source_id": "string",
"request_time": 0,
"request_method": "string",
"request_url": "string",
"request_headers": {"property1": ["string"
],
"property2": ["string"
]
},
"request_body": "string",
"raw_request_body": "string",
"response_time": 0,
"response_headers": {"property1": ["string"
],
"property2": ["string"
]
},
"response_code": 0,
"response_body": "string",
"call_statistics": {"call_start": "string",
"dns_start": "string",
"dns_end": "string",
"connect_start": "string",
"secure_connect_start": "string",
"secure_connect_end": "string",
"connect_end": "string",
"connection_acquired": "string",
"request_headers_start": "string",
"request_headers_end": "string",
"request_body_start": "string",
"request_body_end": "string",
"response_headers_start": "string",
"response_headers_end": "string",
"response_body_start": "string",
"response_body_end": "string",
"connection_released": "string",
"call_end": "string"
},
"duration_statistics": {"dns_lookup_duration": 0,
"tcp_connection_duration": 0,
"tls_handshake_duration": 0,
"sending_request_duration": 0,
"wait_response_duration": 0,
"receive_response_duration": 0,
"overhead_duration": 0,
"total_duration": 0,
"connection_reused": true
}
}

Response samples

application/json

{"tenant": "string",
"identifier": "string",
"order_id": "string",
"correlation_id": "string",
"event_type": "INBOUND",
"request_type": "string",
"source_type": "string",
"source_id": "string",
"request_time": 0,
"response_time": 0,
"response_code": 0,
"s3_content_key": "string",
"s3_content_bucket": "string",
"details_json": "string"
}