Skip to main content
PATCH
/
v1
/
sweeps
/
{id}
/
items
/
{itemId}
Update sweep item
curl --request PATCH \
  --url http://localhost:3000/v1/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"
}
'
{
  "success": true,
  "item": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "retailer_mapping_id": "<string>",
    "store_item_id": "<string>",
    "quantity": 123,
    "picked_quantity": 123,
    "status": "pending",
    "notes": "<string>",
    "store_location_text": "<string>",
    "store_aisle": 123,
    "unit_price": 123,
    "actual_price": 123,
    "is_for_inventory": true,
    "product": {
      "id": "<string>",
      "sellable_product_id": "<string>",
      "taxonomy_id": "<string>",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "barcode": "<string>",
      "scan_barcode": "<string>",
      "norm_barcode": "<string>",
      "size": "<string>",
      "product_page_url": "<string>"
    },
    "scraped_product": {
      "id": "<string>",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "barcode": "<string>"
    }
  }
}

Path Parameters

id
string
required

Sweep UUID or taxonomy ID

itemId
string<uuid>
required

Sweep item UUID

Body

application/json
picked_quantity
number
status
enum<string>
Available options:
pending,
picked,
unavailable,
substituted
notes
string
actual_price
number
partial_reason
enum<string>
Available options:
out_of_stock,
cant_locate

Response

Item updated successfully

success
boolean
required
item
object
required