> ## 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. # Partially capture serial numbers for a package line > Captures N-of-total serial numbers for a single package-item line, allowing progressive scan as units are picked. Each call upserts the submitted serials as ALLOCATED in inventory.serial_numbers and merges them into fulfillment.package_items.serial_numbers JSONB atomically. When remaining > 0, partial: true is returned. Call again with additional serials as each unit is scanned. When remaining reaches 0, partial: false signals the line is ready to fulfill. Duplicate serials within the same package are rejected with 409 duplicate_serial_number. Serials already SOLD on another order are rejected with 422 serial_already_sold. Serials belonging to a different product are rejected with 422 serial_product_mismatch. Layer 1: every SQL write is scoped to entity_id from the API key. Rule 13: emits broadcast serial.captured { partial: true }. Rule 20: logActivity serial_captured. Idempotency-Key honored. MUST precede /:id wildcard in dispatch routing (Phase D.1 2026-05-19). Scope: serials:write. ## OpenAPI ````yaml /openapi.yaml post /serials/capture-partial 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__` (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/capture-partial: post: tags: - Serials summary: Partially capture serial numbers for a package line description: > Captures N-of-total serial numbers for a single package-item line, allowing progressive scan as units are picked. Each call upserts the submitted serials as ALLOCATED in inventory.serial_numbers and merges them into fulfillment.package_items.serial_numbers JSONB atomically. When remaining > 0, partial: true is returned. Call again with additional serials as each unit is scanned. When remaining reaches 0, partial: false signals the line is ready to fulfill. Duplicate serials within the same package are rejected with 409 duplicate_serial_number. Serials already SOLD on another order are rejected with 422 serial_already_sold. Serials belonging to a different product are rejected with 422 serial_product_mismatch. Layer 1: every SQL write is scoped to entity_id from the API key. Rule 13: emits broadcast serial.captured { partial: true }. Rule 20: logActivity serial_captured. Idempotency-Key honored. MUST precede /:id wildcard in dispatch routing (Phase D.1 2026-05-19). Scope: serials:write. operationId: capturePartialSerialsV1 parameters: - name: Idempotency-Key in: header required: false schema: type: string maxLength: 255 description: >- Client-supplied idempotency key (UUID recommended). Same key within 24h returns the cached response. requestBody: required: true content: application/json: schema: type: object required: - package_item_id - product_id properties: package_item_id: type: string format: uuid description: UUID of fulfillment.package_items row to capture against. product_id: type: string format: uuid description: >- UUID of the product. Used for per-product serial_config lookup. order_id: type: string format: uuid nullable: true description: Optional. Parent order UUID for order-state gate validation. package_id: type: string format: uuid nullable: true description: Optional. Parent package UUID. raw_barcodes: type: array items: type: string description: >- Raw scanned strings. The canonical parseScan runs barcode normalization (prefix strip, format parse, lot extraction). Prefer this over serial_numbers[]. serial_numbers: type: array items: type: string description: >- Pre-parsed serial numbers. Use raw_barcodes when possible; serial_numbers bypasses barcode parsing. lot_number: type: string nullable: true description: >- Override lot number. If omitted, parsed from raw_barcodes via parseScan. expiry_date: type: string format: date nullable: true description: >- Override expiry date. If omitted, parsed from raw_barcodes via parseScan. notes: type: string nullable: true description: Optional operator notes stored on the serial row. source: type: string nullable: true description: >- Optional capture source tag (e.g. 'scanner', 'manual', 'api'). responses: '201': description: Partial or complete capture result content: application/json: schema: type: object properties: data: type: object properties: captured_count: type: integer description: Number of serials captured in this call. total_required: type: integer description: Total serial slots required for the package item. remaining: type: integer description: Slots still outstanding after this call. partial: type: boolean description: true when remaining > 0. serials: type: array items: $ref: '#/components/schemas/Serial' '400': $ref: '#/components/responses/Error' '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': description: package_item_not_found or product_not_found content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: duplicate_serial_number content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- serial_already_sold or serial_product_mismatch or serial_release_blocked_order_locked content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: - serials:write 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 Error: description: | Alias for ErrorEnvelope. Canonical error response shape used by all API endpoints. Refer to ErrorEnvelope for the full field definition. allOf: - $ref: '#/components/schemas/ErrorEnvelope' 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__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````