{
"return": {
"id": "<string>",
"status": "canceled",
"refund_amount": 123,
"order_id": "<string>",
"items": [
{
"id": "<string>",
"quantity": 123,
"received_quantity": 123,
"damaged_quantity": 123,
"reason_id": "<string>",
"note": "<string>",
"item_id": "<string>",
"return_id": "<string>",
"metadata": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"exchange_id": "<string>",
"location_id": "<string>",
"claim_id": "<string>",
"order_version": 123,
"display_id": 123,
"no_notification": true,
"received_at": "<string>"
}
}Add received items to return.
{
"return": {
"id": "<string>",
"status": "canceled",
"refund_amount": 123,
"order_id": "<string>",
"items": [
{
"id": "<string>",
"quantity": 123,
"received_quantity": 123,
"damaged_quantity": 123,
"reason_id": "<string>",
"note": "<string>",
"item_id": "<string>",
"return_id": "<string>",
"metadata": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"exchange_id": "<string>",
"location_id": "<string>",
"claim_id": "<string>",
"order_version": 123,
"display_id": 123,
"no_notification": true,
"received_at": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID of the return.
Comma-separated fields that should be included in the returned data.
OK
The return's details.
Show child attributes
The return's ID.
The return's status.
canceled, requested, received, partially_received The amount refunded by this return.
The ID of the associated order.
The return's items.
Show child attributes
The return item's ID.
The return item's quantity.
The received quantity of the item. This quantity is added to the stocked inventory quantity of the item.
The received damaged quantity of the item, which isn't added to the stocked inventory quantity of the item.
The ID of the return reason associated with the item.
A note about why the item was returned.
The ID of the associated order item.
The ID of the return this return item belongs to.
The return item's metadata, can hold custom key-value pairs.
The date the return was created.
The date the return was canceled.
The return's exchange id.
The return's location id.
The return's claim id.
The return's order version.
The return's display id.
Whether the customer should receive notifications about the return's updates.
The date the return was received.