curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/changes' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
{
"order_changes": [
{
"id": "ordch_01HXYZABCDEF",
"order_id": "order_01HXYZABCDEF",
"version": 2,
"change_type": "return",
"status": "confirmed",
"created_by": "sel_01HXYZABCDEF",
"actions": [
{
"id": "ordchact_01HXYZABCDEF",
"action": "RETURN_ITEM",
"details": { "quantity": 1 }
}
],
"created_at": "2026-06-02T10:00:00.000Z",
"confirmed_at": "2026-06-02T11:00:00.000Z"
}
]
}
Orders
List Order Changes
Retrieve the change history of an order.
GET
/
vendor
/
orders
/
{id}
/
changes
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/changes' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
{
"order_changes": [
{
"id": "ordch_01HXYZABCDEF",
"order_id": "order_01HXYZABCDEF",
"version": 2,
"change_type": "return",
"status": "confirmed",
"created_by": "sel_01HXYZABCDEF",
"actions": [
{
"id": "ordchact_01HXYZABCDEF",
"action": "RETURN_ITEM",
"details": { "quantity": 1 }
}
],
"created_at": "2026-06-02T10:00:00.000Z",
"confirmed_at": "2026-06-02T11:00:00.000Z"
}
]
}
Returns all order changes (edits, returns, exchanges, claims) recorded for the order, with their actions.
Path parameters
The order’s ID.
Query parameters
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.Response
Show properties
Show properties
The order change’s ID.
ID of the order the change belongs to.
Order version the change targets.
Type of change, e.g.
edit, return, exchange, claim.The change’s status, e.g.
pending, confirmed, canceled.ID of the actor who created the change.
ID of the actor who confirmed the change.
ID of the actor who canceled the change.
The individual actions that make up the change.
Creation timestamp.
Last update timestamp.
Confirmation timestamp.
Cancellation timestamp.
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/changes' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
{
"order_changes": [
{
"id": "ordch_01HXYZABCDEF",
"order_id": "order_01HXYZABCDEF",
"version": 2,
"change_type": "return",
"status": "confirmed",
"created_by": "sel_01HXYZABCDEF",
"actions": [
{
"id": "ordchact_01HXYZABCDEF",
"action": "RETURN_ITEM",
"details": { "quantity": 1 }
}
],
"created_at": "2026-06-02T10:00:00.000Z",
"confirmed_at": "2026-06-02T11:00:00.000Z"
}
]
}
⌘I