> ## 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.

# Update sweep item

> Update a sweep item's picked quantity, status, or notes



## OpenAPI

````yaml api-reference/v1/openapi.yaml patch /v1/sweeps/{id}/items/{itemId}
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/sweeps/{id}/items/{itemId}:
    patch:
      tags:
        - Sweeps
      summary: Update sweep item
      description: Update a sweep item's picked quantity, status, or notes
      parameters:
        - schema:
            type: string
            description: Sweep UUID or taxonomy ID
          required: true
          name: id
          in: path
        - schema:
            type: string
            format: uuid
            description: Sweep item UUID
          required: true
          name: itemId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                picked_quantity:
                  type: number
                status:
                  type: string
                  enum:
                    - pending
                    - picked
                    - unavailable
                    - substituted
                notes:
                  type: string
                actual_price:
                  type: number
                partial_reason:
                  type: string
                  enum:
                    - out_of_stock
                    - cant_locate
                expected_updated_at:
                  type: string
      responses:
        '200':
          description: Item updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  item:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      sweep_id:
                        type: string
                        format: uuid
                      product_id:
                        type: string
                        format: uuid
                      retailer_mapping_id:
                        type: string
                        nullable: true
                      store_item_id:
                        type: string
                        nullable: true
                      quantity:
                        type: number
                      picked_quantity:
                        type: number
                      status:
                        type: string
                        enum:
                          - pending
                          - picked
                          - unavailable
                          - substituted
                      notes:
                        type: string
                        nullable: true
                      store_location_text:
                        type: string
                        nullable: true
                      store_aisle:
                        type: number
                        nullable: true
                      unit_price:
                        type: number
                        nullable: true
                      actual_price:
                        type: number
                        nullable: true
                      is_for_inventory:
                        type: boolean
                      product:
                        type: object
                        properties:
                          id:
                            type: string
                          sellable_product_id:
                            type: string
                            nullable: true
                          taxonomy_id:
                            type: string
                            nullable: true
                          name:
                            type: string
                          brand:
                            type: string
                            nullable: true
                          image_url:
                            type: string
                            nullable: true
                          barcode:
                            type: string
                            nullable: true
                          scan_barcode:
                            type: string
                            nullable: true
                          norm_barcode:
                            type: string
                            nullable: true
                          size:
                            type: string
                            nullable: true
                          product_page_url:
                            type: string
                            nullable: true
                        required:
                          - id
                          - sellable_product_id
                          - taxonomy_id
                          - name
                          - brand
                          - image_url
                          - barcode
                          - scan_barcode
                          - norm_barcode
                          - size
                          - product_page_url
                      scraped_product:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          brand:
                            type: string
                            nullable: true
                          image_url:
                            type: string
                            nullable: true
                          barcode:
                            type: string
                            nullable: true
                        required:
                          - id
                          - name
                          - brand
                          - image_url
                          - barcode
                    required:
                      - id
                      - sweep_id
                      - product_id
                      - retailer_mapping_id
                      - store_item_id
                      - quantity
                      - picked_quantity
                      - status
                      - notes
                      - store_location_text
                      - store_aisle
                      - unit_price
                      - actual_price
                      - is_for_inventory
                      - product
                required:
                  - success
                  - item
        '404':
          description: Sweep or item not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                    example: Not found
                required:
                  - error
        '409':
          description: Conflict - item was modified by another user
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  conflict:
                    type: boolean
                  item:
                    nullable: true
                required:
                  - error
                  - conflict
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                    example: Not found
                required:
                  - error

````