Skip to main content
PATCH
/
v1
/
scanner
/
sweeps
/
{id}
/
items
/
{itemId}
Update sweep item
curl --request PATCH \
  --url http://localhost:3000/v1/scanner/sweeps/{id}/items/{itemId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "picked_quantity": 123,
  "status": "pending",
  "notes": "<string>",
  "actual_price": 123,
  "partial_reason": "out_of_stock",
  "expected_updated_at": "<string>",
  "substitute_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "item": null,
  "error": "<string>",
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.switchyard.run/llms.txt

Use this file to discover all available pages before exploring further.

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