Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Path parameters

string
required
Return ID (UUID)
string
required
Return item ID (UUID)

Request body

SetReturnDispositionRequest
integer,null (int32)
Explicit target bin; otherwise the warehouse’s returns (restock) or quarantine bin is used when one exists.
string
required
One of restock, refurbish, scrap, return_to_vendor, quarantine.
string,null
string,null (uuid)
Lot the received units belong to; restocked/quarantined units are restored to it in the same transaction.
string[]
Serial numbers physically received (count must equal the item quantity); each is marked returned and moved to the disposition’s target status.
integer,null (int32)
Warehouse receiving the stock (default 1).

Response

ReturnItemResponse
string
required
string,null
string,null
string,null
string
required
string,null
string
required
string
required
integer (int32)
required
string
required
string
required
string[]
required
string
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on October 20, 2026