> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a cycle count batch > Creates a cycle count batch, which fans out into one session per warehouse in scope. **Scope Type A (`location`, default):** `warehouse_ids` is required; `location_ids` is optional and requires `count_mode: bin_location`. **Scope Type B (`item`):** supply `product_ids` or `lot_ids` instead; `warehouse_ids` is an optional narrowing filter (omit it to count every warehouse where the selection has stock). Requires the `CS_8871_CYCLE_COUNT_LOCATION_SCOPE` feature flag — a tenant without it gets a `403`, exactly as their UI would hide the option. ## OpenAPI ````yaml /api-reference/build.yaml post /pickflow/cycle-counts openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Purchase Orders description: Get and modify purchase orders - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /pickflow/cycle-counts: post: tags: - Cycle Counts summary: Create a cycle count batch description: >- Creates a cycle count batch, which fans out into one session per warehouse in scope. **Scope Type A (`location`, default):** `warehouse_ids` is required; `location_ids` is optional and requires `count_mode: bin_location`. **Scope Type B (`item`):** supply `product_ids` or `lot_ids` instead; `warehouse_ids` is an optional narrowing filter (omit it to count every warehouse where the selection has stock). Requires the `CS_8871_CYCLE_COUNT_LOCATION_SCOPE` feature flag — a tenant without it gets a `403`, exactly as their UI would hide the option. operationId: createPickflowCycleCountBatch requestBody: required: true content: application/json: schema: type: object description: >- Request body for creating a cycle count batch. **Scope Type A (`location`, the default):** `warehouse_ids` is required. Optionally narrow to specific bins with `location_ids` (which requires `count_mode: bin_location`). **Scope Type B (`item`, requires the `CS_8871_CYCLE_COUNT_LOCATION_SCOPE` feature flag):** supply `product_ids` or `lot_ids` instead. `warehouse_ids` becomes an optional narrowing filter — omit it to count every warehouse where the selection has stock. properties: name: type: string nullable: true scope_type: type: string enum: - location - item default: location warehouse_ids: type: array items: type: integer description: >- Required unless `scope_type=item` (then an optional narrowing filter). location_ids: type: array items: type: integer description: 'Requires `count_mode: bin_location`.' product_ids: type: array items: type: integer description: Scope Type B "Products" sub-mode. lot_ids: type: array items: type: integer description: Scope Type B "Lots" sub-mode. category_ids: type: array items: type: integer sub_category_id: type: integer nullable: true preferred_vendor_ids: type: array items: type: integer count_mode: type: string enum: - sku - bin_location default: sku is_blind_count: type: boolean default: false include_discontinued: type: boolean default: false include_archived: type: boolean default: false include_inactive: type: boolean default: false include_zero_qty: type: boolean default: false remarks: type: string nullable: true examples: locationScope: summary: Scope Type A — whole warehouse value: name: Q3 Warehouse 4 count warehouse_ids: - 4 is_blind_count: true itemScope: summary: Scope Type B — specific products, any warehouse with stock value: scope_type: item product_ids: - 101 - 203 responses: '201': description: >- Created. Returns the batch with its per-warehouse sessions. May include a non-blocking `warning` when some selected products/lots had no stock. content: application/json: schema: type: object description: >- A cycle count batch — the top-level grouping created by `POST /pickflow/cycle-counts`. A batch fans out into one session per warehouse in scope (see `sessions`). properties: id: type: integer uuid: type: string name: type: string nullable: true scopeType: type: string enum: - location - item description: >- `location` (Scope Type A) counts whole warehouses/bins; `item` (Scope Type B) counts specific products or lots. Item scope requires the `CS_8871_CYCLE_COUNT_LOCATION_SCOPE` feature flag. countMode: type: string enum: - sku - bin_location isBlindCount: type: boolean description: >- When true, counters do not see the expected quantity while counting. categoryId: type: integer nullable: true subCategoryId: type: integer nullable: true preferredVendorId: type: integer nullable: true productIds: type: array nullable: true items: type: integer lotIds: type: array nullable: true items: type: integer remarks: type: string nullable: true createdBy: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time sessions: type: array description: The per-warehouse sessions belonging to this batch. items: type: object description: >- A per-warehouse cycle count session. Every batch produces one session per warehouse in scope. This is the CS-8871 response shape returned by the lifecycle endpoints (start, submit-review, reopen, post, cancel, reset-counts) and by the batch endpoints where sessions are nested. properties: id: type: integer uuid: type: string batchId: type: integer warehouseId: type: integer status: type: string enum: - draft - in_progress - pending_review - posted - cancelled skuCount: type: integer description: Number of distinct SKUs in the session. countedSkuCount: type: integer description: Number of SKUs that have been counted so far. theoreticalValue: type: number description: >- System (book) value of the stock in scope, at post time. totalVarianceQty: type: number nullable: true description: Populated once the session reaches pending_review. totalVarianceValue: type: number nullable: true description: Populated once the session reaches pending_review. accuracyPercentage: type: number nullable: true description: Populated once the session reaches pending_review. adjustmentId: type: integer nullable: true description: >- Id of the inventory adjustment created when the session is posted. Set once status is posted. startedBy: type: integer nullable: true startedAt: type: string format: date-time nullable: true postedBy: type: integer nullable: true postedAt: type: string format: date-time nullable: true cancelledBy: type: integer nullable: true cancelledAt: type: string format: date-time nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time sessionsCount: type: integer description: >- Total number of sessions in the batch. Present on the batch list/detail endpoints (redundant with `sessions.length` when the full collection is also returned). warning: type: string description: >- Present only on the create response when `scope_type=item` and some selected products/lots had no stock and were dropped from the count. '401': description: Authentication credentials were missing or invalid content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Authentication credentials are missing or invalid status_code: type: integer example: 401 '403': description: You do not have permission to perform this action content: application/json: schema: type: object properties: error: type: string example: Forbidden message: type: string example: You do not have permission to access this resource status_code: type: integer example: 403 '422': description: Validation error content: application/json: schema: type: object properties: message: type: string errors: type: object additionalProperties: type: array items: type: string security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````