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

# List kit components

> Returns a kit's components, each with its component product, quantity per kit, sequence, and metadata. Returns a 404 if the product is not kit-typed, and requires the `products:read` scope.



## OpenAPI

````yaml /openapi.yaml get /products/{id}/components
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.

    **Changelog.** Entries are dated and name every published contract whose
    MEANING moved, not

    only the ones whose field names changed. The narrative version of the same
    entries, written

    for integrators, is published at https://arcuserp.mintlify.app/changelog.


    **2026-09-22 (planned 2026-09-21), REORDER-BUYER-TRUTH: demand changed what
    it MEANS on three

    published contracts, with no field renamed.** An integrator that pins field
    names sees no

    breakage and different numbers, which is why this entry exists.

      - **Demand now counts build consumption.** `demand_avg_per_day` on the public product, kit
        and inventory-balance objects, and `daily_demand` / `demand_basis` / `net_suggested_qty`
        on `GET /v1/purchasing/reorder-report`, are composed from fulfilled sales lines PLUS
        posted `build_consume` inventory draws: each physical decrement of a product counts
        exactly once. The previous rule adopted an internal-consumption basis only when the sales
        blend was exactly zero, so a product both sold AND consumed into work orders planned as
        if the build draws did not exist. Products drawn into work orders move; on one
        production-shaped dataset five did, the largest from 0.05/day to 14.95/day.
      - **`demand_basis` now carries four values, not two:** `sales`, `sales_and_builds`,
        `builds` and `consumption`. A consumer with a two-branch reader (anything that is not
        `consumption` is `sales`) silently hides the two new ones.
      - **`current_demand_units` on `GET /v1/inventory/balances/:id` moved, by a second rule.**
        It counts committed-but-unshipped CUSTOMER demand, and it now counts a kit component's
        own line rather than its parent kit line, and excludes non-sales documents. On one
        production dataset 269 of 1,043 balance rows changed, 227 of them downward; the largest
        single move was 1,941 to 25, on a product whose open PURCHASE order line had been
        reported as customer demand. Re-baseline anything that alerts or reorders off this field.
      - `run_rate_30/90/180/365` and `blended_daily` on the same balance object move for the
        first reason above.
      - **Added, not changed:** `GET /v1/purchasing/reorder-report` accepts `demand_window` and
        returns the unit, cover-through and reorder-point-provenance fields documented on that
        operation; `order_multiple` is accepted and returned on the product-vendor doors.
      - **Volume note.** The `inventory.low_stock`, `inventory.out_of_stock` and
        `inventory.back_in_stock` webhook events are population-gated on
        `on_hand <= reorder_point`, and reorder points move with the demand above, so
        subscribers should expect a one-time step change in event volume around the release.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /products/{id}/components:
    get:
      tags:
        - Products
      summary: List kit components
      description: >-
        Returns a kit's components, each with its component product, quantity
        per kit, sequence, and metadata. Returns a 404 if the product is not
        kit-typed, and requires the `products:read` scope.
      operationId: listProductComponents
      parameters:
        - name: id
          in: path
          required: true
          description: UUID of the kit/box parent product.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      responses:
        '200':
          description: List of kit components for the given parent product.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KitComponent'
                  total:
                    type: integer
                  has_more:
                    type: boolean
              example:
                object: list
                data:
                  - id: cccc1111-1111-1111-1111-111111111111
                    object: kit_component
                    entity_id: ent-uuid-here
                    parent_product_id: 11111111-2222-3333-4444-555555555555
                    component_product_id: aaaa1111-1111-1111-1111-111111111111
                    component_product_title: 8oz Glass Jar
                    component_product_sku: JAR-8OZ
                    quantity_per_kit: 2
                    sequence: 1
                    is_assembled: false
                    created_at: '2026-01-15T10:00:00Z'
                    updated_at: '2026-01-15T10:00:00Z'
                  - id: cccc2222-2222-2222-2222-222222222222
                    object: kit_component
                    entity_id: ent-uuid-here
                    parent_product_id: 11111111-2222-3333-4444-555555555555
                    component_product_id: bbbb2222-2222-2222-2222-222222222222
                    component_product_title: Bamboo Lid
                    component_product_sku: LID-BMB
                    quantity_per_kit: 2
                    sequence: 2
                    is_assembled: false
                    created_at: '2026-01-15T10:00:00Z'
                    updated_at: '2026-01-15T10:00:00Z'
                total: 2
                has_more: false
        '400':
          description: Invalid product UUID format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          description: >-
            Product not found, or product belongs to a different entity than the
            API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - ApiKeyAuth:
            - products:read
components:
  schemas:
    KitComponent:
      type: object
      description: >
        One component (BOM row) of an assembly. COMPONENTS-CONSOLIDATION

        (2026-05-18): backed by `public.assembly_components` (unified product +

        variant kits). Many-to-one with the parent via XOR anchor: exactly one
        of

        `parent_product_id` (product-level kit, the most common case for
        `product_type`

        in `[kit, box]`) or `parent_variant_id` (variant-level kit where a
        specific

        variant has its own bill of materials, e.g. one variant of a
        configurable

        product) is set. Each row references a child `component_product_id`

        (the consumed SKU), optionally a `component_variant_id` (when the

        consumed item is a specific variant), and `quantity_per_kit` for the

        per-parent multiplier.
      properties:
        id:
          type: string
          format: uuid
        object:
          type: string
          enum:
            - kit_component
        entity_id:
          type: string
          format: uuid
          readOnly: true
        parent_product_id:
          type: string
          format: uuid
          nullable: true
          description: The kit/box product. Set when this row anchors a product-level kit.
        parent_variant_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            The kit variant. Set when this row anchors a variant-level kit.
            Exactly one of parent_product_id or parent_variant_id is set.
        component_product_id:
          type: string
          format: uuid
          description: The child SKU.
        component_variant_id:
          type: string
          format: uuid
          nullable: true
          description: 'Optional: a specific variant of the child SKU.'
        component_product_title:
          type: string
          readOnly: true
        component_product_sku:
          type: string
          nullable: true
          readOnly: true
        quantity_per_kit:
          type: number
          description: How many of the child SKU are in one kit unit. Must be > 0.
        sort_order:
          type: integer
          nullable: true
          description: Optional display / pick order.
        notes:
          type: string
          nullable: true
        tax_code_override:
          type: string
          nullable: true
          description: Per-row tax code override; null = inherit from component product.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````

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