List Order Change Logs

Returns the transactional change history for an order (create, updates, and other recorded changes).

Results are sorted by log_date ascending by default. Pass sort_order=DESC for newest-first.

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"
sort_order
string
Default: "ASC"

Sort direction by log timestamp. Omit or ASC for oldest-first; DESC for newest-first.

Enum: "ASC" "DESC"
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

Change logs retrieved successfully.

404

Order not found.

get/orders/{reference}/change-logs
Request samples 
Response samples 
application/json
[
  • {
    }
]