> ## 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 lots > Returns lots for the entity. Filter by `product_id`, `status`, or `vendor_id`. Requires the `lots:read` scope. ## OpenAPI ````yaml /openapi.yaml get /lots 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: /lots: get: tags: - Lots summary: List lots description: | Returns lots for the entity. Filter by `product_id`, `status`, or `vendor_id`. Requires the `lots:read` scope. operationId: listLotsV1 parameters: - name: product_id in: query required: false schema: type: string format: uuid - name: vendor_id in: query required: false schema: type: string format: uuid - name: status in: query required: false schema: type: string enum: - active - on_hold - expired - recalled - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/StartingAfter' responses: '200': description: Lot list content: application/json: schema: type: object properties: object: type: string example: list data: type: array items: $ref: '#/components/schemas/Lot' has_more: type: boolean security: - ApiKeyAuth: - lots:read components: parameters: Limit: name: limit in: query required: false description: | Maximum number of records to return per page. Default 25, max 500. Use together with starting_after for cursor pagination. For larger bulk extraction workflows prefer the migration endpoints. schema: type: integer minimum: 1 maximum: 500 default: 25 StartingAfter: name: starting_after in: query required: false description: | Cursor for pagination. Pass the id of the last record from the previous page to fetch the next page. Mutually exclusive with ending_before. schema: type: string maxLength: 200 schemas: Lot: type: object description: > A lot-tracked production batch of a product. Created when receiving lot- tracked inventory and consumed via FEFO (first-expiry-first-out) at allocation time. Status walks `active -> on_hold -> expired -> recalled` via the change-status endpoint. Soft-delete refuses when `quantity_on_hand > 0` (HTTP 409). Scope: lots:read / lots:write / lots:delete. Rule 23 SSOT: `quantity_on_hand` is written only by canonical inventory_transactions postings; the API never writes it directly. properties: id: type: string format: uuid readOnly: true object: type: string example: lot entity_id: type: string format: uuid readOnly: true product_id: type: string format: uuid lot_code: type: string description: Operator-supplied or vendor-supplied lot identifier. 1..100 chars. vendor_id: type: string format: uuid nullable: true manufacture_date: type: string format: date nullable: true expiration_date: type: string format: date nullable: true received_at: type: string format: date-time nullable: true cost: type: number format: float nullable: true description: Per-unit landed cost at receipt (USD). quantity_received: type: number format: float description: Original receive quantity. Immutable after creation. quantity_on_hand: type: number format: float readOnly: true description: 'Current on-hand. SSOT: derived via inventory_transactions.' quantity_consumed: type: number format: float readOnly: true quantity_written_off: type: number format: float readOnly: true status: type: string enum: - active - on_hold - expired - recalled description: >- Lifecycle state. Changed via POST /lots/{id}/change-status with mandatory reason. example: active notes: type: string nullable: true external_source: type: string nullable: true description: Migration provenance (e.g. versa, bubble). external_id: type: string nullable: true metadata: type: object description: Free-form caller metadata. Default {}. inventory_summary: type: object readOnly: true description: >- Computed aggregate joined on lot_id from inventory.inventory_transactions. Only on GET /lots/{id}, not on list. properties: on_hand: type: number format: float description: >- Sum of inventory_transactions.quantity for this lot, scoped to entity. created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true 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. ````