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

> Returns a page of serial-tracked units for the calling entity. Honors
Layer 4 location scoping via the `X-Location-Id` header (takes precedence
over `location_id` query). The canonical handler filters
`inventory.serial_numbers.location_id` directly. Page-based pagination
(`page` + `per_page`); response includes `stats` + `tab_counts` aggregates
for the UI rail. Requires the `serials:read` scope.




## OpenAPI

````yaml /openapi.yaml get /serials
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.
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:
  /serials:
    get:
      tags:
        - Serials
      summary: List serials
      description: >
        Returns a page of serial-tracked units for the calling entity. Honors

        Layer 4 location scoping via the `X-Location-Id` header (takes
        precedence

        over `location_id` query). The canonical handler filters

        `inventory.serial_numbers.location_id` directly. Page-based pagination

        (`page` + `per_page`); response includes `stats` + `tab_counts`
        aggregates

        for the UI rail. Requires the `serials:read` scope.
      operationId: listSerialsV1
      parameters:
        - name: product_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - available
              - allocated
              - sold
              - returned
              - dispositioned
        - name: location_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Layer 4 scope. X-Location-Id header takes precedence.
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Partial serial_number match.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 250
            default: 25
      responses:
        '200':
          description: Serial list (page envelope)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Serial'
                  total:
                    type: integer
                  page:
                    type: integer
                  per_page:
                    type: integer
                  total_pages:
                    type: integer
                  stats:
                    type: object
                    description: Entity-wide aggregates over the filtered set.
                    properties:
                      total:
                        type: integer
                      available:
                        type: integer
                      sold:
                        type: integer
                      returned:
                        type: integer
                      voided:
                        type: integer
                      warranty_expiring:
                        type: integer
                      entity_wide_total:
                        type: integer
                  tab_counts:
                    type: object
                    description: Counts for UI tab badges.
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - serials:read
components:
  schemas:
    Serial:
      type: object
      description: >
        A serial-tracked unit of a product. Created in bulk by generateSerials
        at purchase-order receipt (status `available`) and walks the lifecycle
        `available -> allocated -> sold -> returned -> dispositioned`. The
        `disposition` action records a terminal outcome (restock, write_off,
        return_to_vendor) and the `link-lot` action attaches the serial to a lot
        for traceability. Scope: serials:read / serials:write / serials:delete.
        Rule 23 SSOT: `status` is written only by canonical generateSerials /
        allocateSerial / consumeSerial / receiveSerialReturn /
        dispositionSerial.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        object:
          type: string
          example: serial
        entity_id:
          type: string
          format: uuid
          readOnly: true
        product_id:
          type: string
          format: uuid
        serial_number:
          type: string
          description: Unique-per-product serial value. 1..255 chars.
        status:
          type: string
          enum:
            - available
            - allocated
            - sold
            - returned
            - dispositioned
          description: Lifecycle state. See enum serial_status.
          example: available
        location_id:
          type: string
          format: uuid
          nullable: true
          description: Layer 4 location scope; serials are warehouse-bound.
        order_id:
          type: string
          format: uuid
          nullable: true
          description: Current allocation/sale order, if any.
        order_item_id:
          type: string
          format: uuid
          nullable: true
        package_id:
          type: string
          format: uuid
          nullable: true
          description: Current outbound package, if any.
        package_item_id:
          type: string
          format: uuid
          nullable: true
        lot_id:
          type: string
          format: uuid
          nullable: true
          description: Linked lot for traceability; null if not lot-tracked.
        lot_number:
          type: string
          nullable: true
          description: Convenience copy of lots.lot_code at link time; lot_id is the FK.
        expiry_date:
          type: string
          format: date
          nullable: true
        warranty_start_date:
          type: string
          format: date-time
          nullable: true
        warranty_end_date:
          type: string
          format: date-time
          nullable: true
        extended_warranty_end_date:
          type: string
          format: date-time
          nullable: true
        warranty_status:
          type: string
          nullable: true
          description: active, expired, voided.
        received_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        sold_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        returned_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        last_scanned_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        last_order_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
          description: Previous allocation; preserved through return cycles.
        last_order_item_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        last_package_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        last_package_item_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        notes:
          type: string
          nullable: true
        created_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.

````