> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onosso.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Check, uncheck, move or change the quantity of an item

> Writes a new version of the item: with `bought`, checked or not; with `placeId` and/or `quantity`, moved (the place becomes `confirmed`) or recounted. A body carries `bought` or the edit, not both. The previous version is superseded, never edited. `supersedes` is the version being replaced. A stale one that asks for what the item already is returns the item unchanged; a stale one that asks for something else is a conflict naming the current version. `operationId` makes a retry safe.



## OpenAPI

````yaml /openapi.json patch /v1/shopping/items/{itemId}
openapi: 3.0.0
info:
  title: onosso
  version: 0.0.0
  description: >-
    The household's API: the week, the people and the sessions the web app reads
    and changes.
servers: []
security: []
tags:
  - name: Week
    description: The household's week, day by day.
  - name: People
    description: The people who make up the household.
  - name: Pets
    description: The pets of the house.
  - name: Invites
    description: Links that let someone join.
  - name: Sessions
    description: Where you are signed in.
  - name: Tokens
    description: Your personal API tokens.
  - name: Address
    description: Where the household lives.
  - name: Messages
    description: What each person receives from the product, and when.
  - name: Questions
    description: 'What needs a person: one queue, the same in the app and on WhatsApp.'
  - name: Shopping
    description: 'The household''s one list: places, items and marks.'
  - name: Conversation
    description: >-
      Each person's one conversation with the assistant, the same in the app and
      on WhatsApp.
  - name: MCP
    description: The house for an MCP client such as Claude Desktop, with a personal token.
paths:
  /v1/shopping/items/{itemId}:
    patch:
      tags:
        - Shopping
      summary: Check, uncheck, move or change the quantity of an item
      description: >-
        Writes a new version of the item: with `bought`, checked or not; with
        `placeId` and/or `quantity`, moved (the place becomes `confirmed`) or
        recounted. A body carries `bought` or the edit, not both. The previous
        version is superseded, never edited. `supersedes` is the version being
        replaced. A stale one that asks for what the item already is returns the
        item unchanged; a stale one that asks for something else is a conflict
        naming the current version. `operationId` makes a retry safe.
      parameters:
        - schema:
            type: string
            maxLength: 64
          required: true
          name: itemId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bought:
                  type: boolean
                placeId:
                  type: string
                  maxLength: 64
                quantity:
                  type: string
                  minLength: 1
                  maxLength: 40
                supersedes:
                  type: string
                  maxLength: 64
                operationId:
                  type: string
                  format: uuid
                at:
                  type: string
                  format: date-time
              required:
                - supersedes
                - operationId
                - at
      responses:
        '200':
          description: The item at its new version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShoppingItem'
        '401':
          $ref: '#/components/responses/ShoppingUnauthorized'
        '403':
          $ref: '#/components/responses/ShoppingForbidden'
        '404':
          $ref: '#/components/responses/ShoppingNotFound'
        '409':
          description: >-
            Someone changed the item since `supersedes`; `details` names the
            item and its current version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainError'
        '422':
          $ref: '#/components/responses/ShoppingInvalid'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/RequestTimeout'
      security:
        - session: []
components:
  schemas:
    ShoppingItem:
      type: object
      properties:
        id:
          type: string
        version:
          type: string
        placeId:
          type: string
        name:
          type: string
        quantity:
          type: string
          nullable: true
        section:
          type: string
          nullable: true
        bought:
          type: boolean
        placeConfidence:
          type: string
          enum:
            - confirmed
            - assumed
        addedBy:
          type: object
          properties:
            personId:
              type: string
            displayName:
              type: string
          required:
            - personId
            - displayName
        addedAt:
          type: string
          format: date-time
        changedBy:
          type: object
          properties:
            personId:
              type: string
            displayName:
              type: string
          required:
            - personId
            - displayName
        changedAt:
          type: string
          format: date-time
      required:
        - id
        - version
        - placeId
        - name
        - quantity
        - section
        - bought
        - placeConfidence
        - addedBy
        - addedAt
        - changedBy
        - changedAt
    DomainError:
      type: object
      properties:
        code:
          type: string
        details:
          type: object
          additionalProperties:
            nullable: true
      required:
        - code
        - details
    Unauthorized:
      type: object
      properties:
        message:
          type: string
          enum:
            - Unauthorized
        statusCode:
          type: number
          enum:
            - 401
      required:
        - message
        - statusCode
    Forbidden:
      type: object
      properties:
        message:
          type: string
          enum:
            - Forbidden
        statusCode:
          type: number
          enum:
            - 403
      required:
        - message
        - statusCode
    Degraded:
      type: object
      properties:
        code:
          type: string
          enum:
            - request.timeout
            - service.unavailable
        correlationId:
          type: string
      required:
        - code
        - correlationId
  responses:
    ShoppingUnauthorized:
      description: The session is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    ShoppingForbidden:
      description: The request origin is not allowed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Forbidden'
    ShoppingNotFound:
      description: >-
        The place, the item, the decline or the menu choice is not in the
        caller's household.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainError'
    ShoppingInvalid:
      description: The body is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainError'
    ServiceUnavailable:
      description: A dependency is unavailable; retry after Retry-After seconds.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Degraded'
    RequestTimeout:
      description: The request outlived its deadline.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Degraded'
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: The session cookie set when you sign in to the web app.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.