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

# Add an item

> Adds an open item. Without `placeId` the place is inferred from the house's own history (the place of its latest item of that name, else its first place) and is `assumed`. A name already open is summed onto that item as its next version, unless `repeat` is `separate`. With `fromSuggestion` (a suggestion's `id`) and nothing else, the item is that suggestion, with its name, quantity, place and section; a name already open is returned as it is. `operationId` makes a retry safe.



## OpenAPI

````yaml /openapi.json post /v1/shopping/items
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:
    post:
      tags:
        - Shopping
      summary: Add an item
      description: >-
        Adds an open item. Without `placeId` the place is inferred from the
        house's own history (the place of its latest item of that name, else its
        first place) and is `assumed`. A name already open is summed onto that
        item as its next version, unless `repeat` is `separate`. With
        `fromSuggestion` (a suggestion's `id`) and nothing else, the item is
        that suggestion, with its name, quantity, place and section; a name
        already open is returned as it is. `operationId` makes a retry safe.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              anyOf:
                - type: object
                  properties:
                    fromSuggestion:
                      type: string
                      maxLength: 64
                    operationId:
                      type: string
                      format: uuid
                    at:
                      type: string
                      format: date-time
                  required:
                    - fromSuggestion
                    - operationId
                    - at
                  additionalProperties: false
                - type: object
                  properties:
                    placeId:
                      type: string
                      maxLength: 64
                    name:
                      type: string
                      minLength: 1
                      maxLength: 200
                    quantity:
                      type: string
                      minLength: 1
                      maxLength: 40
                    section:
                      type: string
                      minLength: 1
                      maxLength: 80
                    repeat:
                      type: string
                      enum:
                        - sum
                        - separate
                    operationId:
                      type: string
                      format: uuid
                    at:
                      type: string
                      format: date-time
                  required:
                    - name
                    - operationId
                    - at
      responses:
        '200':
          description: >-
            The name was already open: the item at its summed version, or, for a
            suggestion, the open item unchanged.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ShoppingPutItem'
                  - $ref: '#/components/schemas/ShoppingItem'
        '201':
          description: The item was added.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ShoppingPutItem'
                  - $ref: '#/components/schemas/ShoppingItem'
        '401':
          $ref: '#/components/responses/ShoppingUnauthorized'
        '403':
          $ref: '#/components/responses/ShoppingForbidden'
        '404':
          $ref: '#/components/responses/ShoppingNotFound'
        '422':
          $ref: '#/components/responses/ShoppingInvalid'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/RequestTimeout'
      security:
        - session: []
components:
  schemas:
    ShoppingPutItem:
      allOf:
        - $ref: '#/components/schemas/ShoppingItem'
        - type: object
          properties:
            outcome:
              type: string
              enum:
                - added
                - summed
          required:
            - outcome
    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
    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
    DomainError:
      type: object
      properties:
        code:
          type: string
        details:
          type: object
          additionalProperties:
            nullable: true
      required:
        - code
        - details
    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.