Skip to main content
POST
Assess Dispositions

Authorizations

X-Authorization
string
header
required

Body

application/json
items
object[]
required

An array of items to be dispositioned.

Required array length: 1 - 30 elements

Response

Success

Maximum array length: 30
line_item_id
integer
required

The unique identifier associated with the line item.

Example:

1

disposition_outcome
enum<string>
required

The final state of the returned item.

Available options:
back_to_stock,
resale_hold,
recycle,
donate,
missing
return_processor
string

The email address of the warehouse partner used to process returns.

Maximum string length: 100
Example:

"warehouse-operator@example.com"

note
string

Any additional notes on the item's final state.

Maximum string length: 65535
Example:

"This item will be returned to stock after bagging and tagging."

inspected_at
string<date-time>

The date and time at which the item was inspected, in RFC 3339 (ISO 8601) format with a UTC offset (DATE_ATOM), e.g. 2024-03-31T23:59:59+00:00.

Example:

"2024-03-31T23:59:59+00:00"