curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q3 Warehouse 4 count",
  "warehouse_ids": [
    4
  ],
  "is_blind_count": true
}
'

{
  "id": 123,
  "uuid": "<string>",
  "name": "<string>",
  "isBlindCount": true,
  "categoryId": 123,
  "subCategoryId": 123,
  "preferredVendorId": 123,
  "productIds": [
    123
  ],
  "lotIds": [
    123
  ],
  "remarks": "<string>",
  "createdBy": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sessions": [
    {
      "id": 123,
      "uuid": "<string>",
      "batchId": 123,
      "warehouseId": 123,
      "skuCount": 123,
      "countedSkuCount": 123,
      "theoreticalValue": 123,
      "totalVarianceQty": 123,
      "totalVarianceValue": 123,
      "accuracyPercentage": 123,
      "adjustmentId": 123,
      "startedBy": 123,
      "startedAt": "2023-11-07T05:31:56Z",
      "postedBy": 123,
      "postedAt": "2023-11-07T05:31:56Z",
      "cancelledBy": 123,
      "cancelledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "sessionsCount": 123,
  "warning": "<string>"
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource",
  "status_code": 403
}

{
  "message": "<string>",
  "errors": {}
}

Cycle Counts

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.

POST

pickflow

cycle-counts

curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q3 Warehouse 4 count",
  "warehouse_ids": [
    4
  ],
  "is_blind_count": true
}
'

{
  "id": 123,
  "uuid": "<string>",
  "name": "<string>",
  "isBlindCount": true,
  "categoryId": 123,
  "subCategoryId": 123,
  "preferredVendorId": 123,
  "productIds": [
    123
  ],
  "lotIds": [
    123
  ],
  "remarks": "<string>",
  "createdBy": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sessions": [
    {
      "id": 123,
      "uuid": "<string>",
      "batchId": 123,
      "warehouseId": 123,
      "skuCount": 123,
      "countedSkuCount": 123,
      "theoreticalValue": 123,
      "totalVarianceQty": 123,
      "totalVarianceValue": 123,
      "accuracyPercentage": 123,
      "adjustmentId": 123,
      "startedBy": 123,
      "startedAt": "2023-11-07T05:31:56Z",
      "postedBy": 123,
      "postedAt": "2023-11-07T05:31:56Z",
      "cancelledBy": 123,
      "cancelledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "sessionsCount": 123,
  "warning": "<string>"
}

{
  "error": "Unauthorized",
  "message": "Authentication credentials are missing or invalid",
  "status_code": 401
}

{
  "error": "Forbidden",
  "message": "You do not have permission to access this resource",
  "status_code": 403
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json

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.

name

string | null

scope_type

enum<string>

default:location

Available options:

location,

item

warehouse_ids

integer[]

Required unless scope_type=item (then an optional narrowing filter).

location_ids

integer[]

Requires count_mode: bin_location.

product_ids

integer[]

Scope Type B "Products" sub-mode.

lot_ids

integer[]

Scope Type B "Lots" sub-mode.

category_ids

integer[]

sub_category_id

integer | null

preferred_vendor_ids

integer[]

count_mode

enum<string>

default:sku

Available options:

sku,

bin_location

is_blind_count

boolean

default:false

include_discontinued

boolean

default:false

include_archived

boolean

default:false

include_inactive

boolean

default:false

include_zero_qty

boolean

default:false

remarks

string | null

Response

Created. Returns the batch with its per-warehouse sessions. May include a non-blocking warning when some selected products/lots had no stock.

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

integer

uuid

string

name

string | null

scopeType

enum<string>

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.

Available options:

location,

item

countMode

enum<string>

Available options:

sku,

bin_location

isBlindCount

boolean

When true, counters do not see the expected quantity while counting.

categoryId

integer | null

subCategoryId

integer | null

preferredVendorId

integer | null

productIds

integer[] | null

lotIds

integer[] | null

remarks

string | null

createdBy

integer

createdAt

string<date-time>

updatedAt

string<date-time>

sessions

object[]

The per-warehouse sessions belonging to this batch.

Show child attributes

sessionsCount

integer

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

string

Present only on the create response when scope_type=item and some selected products/lots had no stock and were dropped from the count.

List active sessions for a warehouse SKU-mode item-count estimate per warehouse

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Create a cycle count batch

Authorizations

Body

Response