Returns
Sales returns anchored to sales orders.
Read endpoints expose line detail and per-item receiving progress.
ออบเจ็กต์ Return
หัวข้อที่มีชื่อว่า “ออบเจ็กต์ Return”A sales return with lines, per-item receiving progress, and linked transactions.
Return id.
Return number.
Return date/time.
Return status. Recording stock through the return's transaction endpoints advances the status automatically: confirmed becomes in-progress once any quantity is received, and done once nothing remains. A done return is never reverted by such transaction changes.
ค่าที่เป็นไปได้confirmedin-progressdone
Customer for the sales return.
แสดงพร็อพเพอร์ตี
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Reference to the source sales order for a return.
แสดงพร็อพเพอร์ตี
Order id.
Order number.
Return total as a decimal string.
Source sales order ISO currency code, or null when unset.
Free-text memo. Empty string when not set.
Optimistic-concurrency version.
Reference to a related entity (location, partner, or user) embedded in a transaction. The snapshot is captured at transaction time and does not update if the source entity is later renamed or removed.
แสดงพร็อพเพอร์ตี
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Server-side creation timestamp.
Web URL to view this return in the BoxHero app.
Read-only tags parsed from the memo.
Detailed return lines.
แสดงพร็อพเพอร์ตี
Return line id.
Line rank in the return.
Source order line id.
Set when the line references a single item.
แสดงพร็อพเพอร์ตี
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Set when the line references a bundle.
แสดงพร็อพเพอร์ตี
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Returned line amount, not a unit price: the source order line's total (including tax and discount) scaled by returned quantity / ordered quantity. Equal to subtotal and total.
Quantity. May include up to four decimal places in core data.
Always null on return lines.
Always null on return lines.
Always null on return lines.
Always null on return lines.
Always null on return lines.
ค่าที่เป็นไปได้percentamount
Always null on return lines.
Same as price: the returned line amount.
Always "0"; any source discount is already reflected in price.
Always "0"; any source tax is already reflected in price.
Same as price: the returned line amount.
Per-item receiving progress. Bundle return lines are exploded and duplicate items are collapsed.
แสดงพร็อพเพอร์ตี
Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.
แสดงพร็อพเพอร์ตี
Item or bundle id.
Display name.
SKU. Empty string when unset.
Barcode. Empty string when unset.
Whether the underlying item or bundle is deleted.
Ordered or returned quantity for this item. Bundle lines are exploded into component quantities and duplicate items are collapsed.
Absolute quantity already fulfilled or received for this item.
Remaining quantity for this item, clamped to zero when over-fulfilled.
Inventory transactions linked to this return.
แสดงพร็อพเพอร์ตี
Location transaction id.
Fulfillment direction of an order-linked transaction.
ค่าที่เป็นไปได้inout
Effective transaction time.
Reference to a related entity (location, partner, or user) embedded in a transaction. The snapshot is captured at transaction time and does not update if the source entity is later renamed or removed.
แสดงพร็อพเพอร์ตี
Id of the referenced entity.
Display name of the entity at the time the transaction was recorded.
true when the underlying entity has since been deleted. The embedded snapshot is preserved so historical transactions remain readable.
Quantity. May include up to four decimal places in core data.
ตัวอย่าง
{ "id": 90301, "return_number": "R-1001", "return_time": "2026-01-15T09:30:00.000Z", "status": "done", "partner": { "id": 431488, "name": "Northwind Retail", "deleted": false }, "order": { "id": 90201, "order_number": "SO-2001" }, "total_price": "99.95", "currency_code": "USD", "memo": "", "revision": 3, "created_by": { "id": 1001, "name": "John Smith", "deleted": false }, "created_at": "2026-01-15T09:30:00.000Z", "url": "https://app.boxhero-app.com/returns/90301", "tags": [], "items": [ { "id": 700301, "rank": 0, "order_item_id": 700201, "item": { "id": 14290445, "name": "Finish Setting Powder", "sku": "SKU-12345678", "barcode": "2097678335587", "deleted": false }, "bundle": null, "price": "99.95", "quantity": 5, "tax_name": null, "tax_rate": null, "tax_inclusive": null, "discount_name": null, "discount_type": null, "discount_value": null, "subtotal": "99.95", "discount_amount": "0", "tax_amount": "0", "total": "99.95" } ], "tx_items": [ { "item": { "id": 14290445, "name": "Finish Setting Powder", "sku": "SKU-12345678", "barcode": "2097678335587", "deleted": false }, "ordered_quantity": 5, "fulfilled_quantity": 5, "pending_quantity": 0 } ], "transactions": [ { "id": 14012345, "type": "in", "transaction_time": "2026-01-16T11:00:00.000Z", "to_location": { "id": 47041, "name": "Warehouse", "deleted": false }, "count_of_items": 1, "total_quantity": 5 } ]}เอนด์พอยต์
หัวข้อที่มีชื่อว่า “เอนด์พอยต์”- List sales returns
GET /v1/returns - Create a sales return
POST /v1/returns - Get a sales return
GET /v1/returns/{return_id} - Update a sales return
PUT /v1/returns/{return_id} - Delete a sales return
DELETE /v1/returns/{return_id} - Receive returned quantities
POST /v1/returns/{return_id}/transactions - Receive all remaining returned quantities
POST /v1/returns/{return_id}/transactions/complete - Get a sales return by return number
GET /v1/returns/by-number/{return_number} - Update a sales return by return number
PUT /v1/returns/by-number/{return_number} - Delete a sales return by return number
DELETE /v1/returns/by-number/{return_number} - Receive returned quantities by return number
POST /v1/returns/by-number/{return_number}/transactions - Receive all remaining returned quantities by return number
POST /v1/returns/by-number/{return_number}/transactions/complete