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

# Adjust finished-good stock with a reason

> **Side effect:** changes `finished_goods.ready_stock` by the signed `adjustment` delta and recalculates the item's status (in_stock / low_stock / out_of_stock). Returns 400 if the resulting stock would be negative. The `reason` enum excludes internal reasons (`print_completion`, `order_fulfillment`, `assembly_completed`) which are reserved for events emitted by other handlers.



## OpenAPI

````yaml /api-reference/openapi.json post /inventory/{id}/adjust
openapi: 3.1.0
info:
  title: AutoPrintFarm Public API
  version: 1.0.0
  description: >-
    Public API for AutoPrintFarm — read + write surface for printers, jobs,
    inventory, orders, SKUs, files, worklist, and assembly. Authorization uses
    three scopes: `read` (any list/get), `write` (data mutations — create,
    update, delete, uploads, fulfillment), and `control` (physical printer
    actions: start, pause, resume, stop, heaters, light, filament). Authenticate
    with an API key minted from Settings → API Keys in the AutoPrintFarm
    dashboard.
  contact:
    name: AutoPrintFarm
    url: https://autoprintfarm.com
servers:
  - url: https://api.autoprintfarm.com/public/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Printers
    description: Printer fleet status
  - name: Jobs
    description: Print job queue and history
  - name: Inventory
    description: Finished-goods stock levels
  - name: Orders
    description: Customer orders and line items
  - name: Wiki
    description: Internal documentation articles
  - name: Worklist
    description: Operational task queue
  - name: Products
    description: Product catalog, SKUs, components, and color presets
  - name: Files
    description: Print file metadata and versions
  - name: Hubs
    description: Hub fleet and connection status
  - name: Assembly
    description: Post-print assembly tasks with bundled wiki
  - name: Materials
    description: Filament, components, packaging, and printer parts inventory
  - name: Analytics
    description: >-
      Dashboard rollups and reporting (overview, production, printers, failures,
      inventory, revenue)
paths:
  /inventory/{id}/adjust:
    post:
      tags:
        - Inventory
      summary: Adjust finished-good stock with a reason
      description: >-
        **Side effect:** changes `finished_goods.ready_stock` by the signed
        `adjustment` delta and recalculates the item's status (in_stock /
        low_stock / out_of_stock). Returns 400 if the resulting stock would be
        negative. The `reason` enum excludes internal reasons
        (`print_completion`, `order_fulfillment`, `assembly_completed`) which
        are reserved for events emitted by other handlers.
      parameters:
        - schema:
            type: string
            description: Finished-good row id.
          required: true
          description: Finished-good row id.
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                adjustment:
                  type: integer
                  description: >-
                    Signed integer delta to apply to `ready_stock` (positive to
                    add, negative to remove). Rejected with 400 if the result
                    would be negative.
                reason:
                  type: string
                  enum:
                    - manual
                    - inventory_count
                    - correction
                    - damaged
                    - returned
                  default: manual
                  description: >-
                    Reason for the adjustment, recorded for audit. Internal
                    reasons (`print_completion`, `order_fulfillment`,
                    `assembly_completed`) are reserved for events emitted by
                    other handlers and are not accepted here.
                notes:
                  type: string
                  maxLength: 500
                  description: Optional free-form note (max 500 chars).
              required:
                - adjustment
      responses:
        '200':
          description: Stock adjusted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      previous_stock:
                        type: number
                      adjustment:
                        type: number
                      new_stock:
                        type: number
                      previous_status:
                        type:
                          - string
                          - 'null'
                      new_status:
                        type: string
                      is_low_stock:
                        type: boolean
                      reason:
                        type: string
                    required:
                      - id
                      - previous_stock
                      - adjustment
                      - new_stock
                      - previous_status
                      - new_status
                      - is_low_stock
                      - reason
                required:
                  - success
                  - data
        '400':
          description: Invalid adjustment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, revoked, or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Item not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (120 req/min/key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - write
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR,
                FORBIDDEN, HUB_OFFLINE). Stable across releases — use this for
                branching.
              example: NOT_FOUND
            message:
              type: string
              description: >-
                Human-readable error message. May vary across releases — do not
                branch on this.
              example: Resource not found
            details:
              description: >-
                Optional structured detail. For VALIDATION_ERROR this is `{
                field: [messages] }`.
          required:
            - code
            - message
          description: Error detail object
      required:
        - success
        - error
      description: Standard error response envelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: apf_live_<64 hex>
      description: >-
        API keys are minted in the AutoPrintFarm web app under Settings → API
        Keys. Send as `Authorization: Bearer apf_live_...`. Keys are shown
        exactly once at creation and can be revoked at any time.

````