{
"order_changes": [
{
"id": "<string>",
"version": 123,
"change_type": "return",
"order_id": "<string>",
"return_id": "<string>",
"exchange_id": "<string>",
"claim_id": "<string>",
"actions": [
{
"id": "<string>",
"order_change_id": "<string>",
"order_id": "<string>",
"return_id": "<string>",
"claim_id": "<string>",
"exchange_id": "<string>",
"reference": "claim",
"reference_id": "<string>",
"action": "CANCEL_RETURN_ITEM",
"details": {},
"internal_note": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"status": "canceled",
"requested_by": "<string>",
"requested_at": "2023-11-07T05:31:56Z",
"confirmed_by": "<string>",
"confirmed_at": "2023-11-07T05:31:56Z",
"declined_by": "<string>",
"declined_reason": "<string>",
"metadata": {},
"declined_at": "2023-11-07T05:31:56Z",
"canceled_by": "<string>",
"canceled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}List Order Changes
Retrieves a list of order changes for the authenticated vendor.
{
"order_changes": [
{
"id": "<string>",
"version": 123,
"change_type": "return",
"order_id": "<string>",
"return_id": "<string>",
"exchange_id": "<string>",
"claim_id": "<string>",
"actions": [
{
"id": "<string>",
"order_change_id": "<string>",
"order_id": "<string>",
"return_id": "<string>",
"claim_id": "<string>",
"exchange_id": "<string>",
"reference": "claim",
"reference_id": "<string>",
"action": "CANCEL_RETURN_ITEM",
"details": {},
"internal_note": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"status": "canceled",
"requested_by": "<string>",
"requested_at": "2023-11-07T05:31:56Z",
"confirmed_by": "<string>",
"confirmed_at": "2023-11-07T05:31:56Z",
"declined_by": "<string>",
"declined_reason": "<string>",
"metadata": {},
"declined_at": "2023-11-07T05:31:56Z",
"canceled_by": "<string>",
"canceled_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Order.
Query Parameters
Comma-separated fields to include in the response.
Response
OK
Show child attributes
Show child attributes
The order change's ID.
The order change's version. This will be the order's version when the change is applied.
The order change's type.
return, exchange, claim, edit The ID of the order this change applies on.
The ID of the associated return.
The ID of the associated exchange.
The ID of the associated claim.
The order change's actions.
Show child attributes
Show child attributes
The action's ID.
The ID of the order change that the action belongs to.
The ID of the order the associated change is for.
The ID of the associated return.
The ID of the associated claim.
The ID of the associated exchange.
The name of the table this action applies on.
claim, exchange, return, order_shipping_method The ID of the record in the referenced table.
The applied action.
CANCEL_RETURN_ITEM, FULFILL_ITEM, DELIVER_ITEM, CANCEL_ITEM_FULFILLMENT, ITEM_ADD, ITEM_REMOVE, ITEM_UPDATE, RECEIVE_DAMAGED_RETURN_ITEM, RECEIVE_RETURN_ITEM, RETURN_ITEM, SHIPPING_ADD, SHIPPING_REMOVE, SHIP_ITEM, WRITE_OFF_ITEM, REINSTATE_ITEM The action's details.
A note that's viewed only by admin users.
The date the action was created.
The date the action was updated.
The order change's status.
canceled, requested, pending, confirmed, declined The ID of the user that requested the change.
The date the order change was requested.
The ID of the user that confirmed the order change.
The date the order change was confirmed.
The ID of the user that declined the order change.
The reason the order change was declined.
The order change's metadata, can hold custom key-value pairs.
The date the order change was declined.
The ID of the user that canceled the order change.
The date the order change was canceled.
The date the order change was created.
The date the order change was updated.