Skip to main content
PATCH
Update sweep item

Path Parameters

id
string<uuid>
required

Sweep ID

itemId
string<uuid>
required

Sweep item ID

Body

application/json
picked_quantity
number

Quantity picked

status
enum<string>

Item status

Available options:
pending,
picked,
unavailable,
substituted
notes
string

Notes for the item

actual_price
number

Actual price paid

partial_reason
enum<string>

Reason for partial pick

Available options:
out_of_stock,
cant_locate
expected_updated_at
string

Optimistic lock: expected updated_at timestamp for conflict detection

substitute_product_id
string<uuid>

Scraped product ID to use as substitute for this item

Response

Item updated successfully

success
boolean
required
item
unknown
error
string
message
string