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

# Start counting

> Transitions a session from `draft` to `in_progress`.



## OpenAPI

````yaml /api-reference/build.yaml post /pickflow/cycle-counts/{sessionId}/start
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/{sessionId}/start:
    post:
      tags:
        - Cycle Counts
      summary: Start counting
      description: Transitions a session from `draft` to `in_progress`.
      operationId: startPickflowCycleCountSession
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: The updated session.
          content:
            application/json:
              schema:
                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
        '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
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
                  message:
                    type: string
                    example: The requested resource could not be found
                  status_code:
                    type: integer
                    example: 404
        '422':
          description: Session is not `draft`.
          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.

````