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

# Decrement component stock

> Decrements `remaining_units` by `quantity` and recomputes `status`. Returns the updated component row alongside a `consumed` summary of the movement. Responds 400 INSUFFICIENT_QUANTITY when the decrement would drop stock below zero. The `assembly_completion` reason is reserved for internal use and not accepted here.



## OpenAPI

````yaml /api-reference/openapi.json post /materials/components/{id}/consume
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:
  /materials/components/{id}/consume:
    post:
      tags:
        - Materials
      summary: Decrement component stock
      description: >-
        Decrements `remaining_units` by `quantity` and recomputes `status`.
        Returns the updated component row alongside a `consumed` summary of the
        movement. Responds 400 INSUFFICIENT_QUANTITY when the decrement would
        drop stock below zero. The `assembly_completion` reason is reserved for
        internal use and not accepted here.
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quantity:
                  type: integer
                  minimum: 1
                  description: Number of units to remove from stock
                reason:
                  type: string
                  enum:
                    - manual_adjustment
                    - damaged
                    - other
                  description: Reason for the decrement. Defaults to `manual_adjustment`.
                notes:
                  type: string
                  maxLength: 500
                  description: Free-form note recorded with the movement
              required:
                - quantity
      responses:
        '200':
          description: Consumed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      component:
                        $ref: '#/components/schemas/MaterialComponent3'
                      consumed:
                        type: object
                        properties:
                          quantity:
                            type: integer
                          reason:
                            type: string
                            enum:
                              - manual_adjustment
                              - damaged
                              - other
                          notes:
                            type:
                              - string
                              - 'null'
                          previous_quantity:
                            type: integer
                          new_quantity:
                            type: integer
                        required:
                          - quantity
                          - reason
                          - notes
                          - previous_quantity
                          - new_quantity
                    required:
                      - component
                      - consumed
                required:
                  - success
                  - data
        '400':
          description: Validation or business-rule error
          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: Resource 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:
    MaterialComponent3:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        name:
          type:
            - string
            - 'null'
        color:
          type:
            - string
            - 'null'
        brand:
          type:
            - string
            - 'null'
        diameter:
          type:
            - string
            - 'null'
        size:
          type:
            - string
            - 'null'
        remaining_units:
          type: number
        low_threshold:
          type:
            - number
            - 'null'
        status:
          type:
            - string
            - 'null'
        location:
          type:
            - string
            - 'null'
        created_at:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
      required:
        - id
        - type
        - name
        - color
        - brand
        - diameter
        - size
        - remaining_units
        - low_threshold
        - status
        - location
        - created_at
        - updated_at
    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.

````