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>'
const { order_changes } = await client.vendor.orders.$id.changes.query({
$id: "order_01HXYZABCDEF",
})
{
"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
string
required
The order’s ID.
Query parameters
string
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.Response
object[]
Show properties
Show properties
string
The order change’s ID.
string
ID of the order the change belongs to.
number
Order version the change targets.
string
Type of change, e.g.
edit, return, exchange, claim.string
The change’s status, e.g.
pending, confirmed, canceled.string
ID of the actor who created the change.
string
ID of the actor who confirmed the change.
string
ID of the actor who canceled the change.
object[]
The individual actions that make up the change.
string
Creation timestamp.
string
Last update timestamp.
string
Confirmation timestamp.
string
Cancellation timestamp.
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/changes' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { order_changes } = await client.vendor.orders.$id.changes.query({
$id: "order_01HXYZABCDEF",
})
{
"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
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/changes' \
-H 'Authorization: Bearer <token>' \
-H 'x-seller-id: <seller_id>'
const { order_changes } = await client.vendor.orders.$id.changes.query({
$id: "order_01HXYZABCDEF",
})
{
"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"
}
]
}