curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 123,
"uuid": "<string>",
"name": "<string>",
"scopeType": "location",
"countMode": "sku",
"isBlindCount": true,
"categoryId": 123,
"subCategoryId": 123,
"preferredVendorId": 123,
"productIds": [
123
],
"lotIds": [
123
],
"products": [
{
"id": 123,
"productName": "<string>",
"internalSku": "<string>"
}
],
"lots": [
{
"id": 123,
"lotNumber": "<string>",
"productName": "<string>",
"expiryDate": "2023-12-25"
}
],
"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,
"status": "draft",
"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": "Not Found",
"message": "The requested resource could not be found",
"status_code": 404
}Get a cycle count batch
Returns a batch with its per-warehouse sessions.
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches/{batchId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 123,
"uuid": "<string>",
"name": "<string>",
"scopeType": "location",
"countMode": "sku",
"isBlindCount": true,
"categoryId": 123,
"subCategoryId": 123,
"preferredVendorId": 123,
"productIds": [
123
],
"lotIds": [
123
],
"products": [
{
"id": 123,
"productName": "<string>",
"internalSku": "<string>"
}
],
"lots": [
{
"id": 123,
"lotNumber": "<string>",
"productName": "<string>",
"expiryDate": "2023-12-25"
}
],
"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,
"status": "draft",
"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": "Not Found",
"message": "The requested resource could not be found",
"status_code": 404
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Response
The batch with its per-warehouse sessions.
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).
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.
location, item sku, bin_location When true, counters do not see the expected quantity while counting.
Resolved item-scope product selections as human-readable names. Present only on single-batch responses (create / batch detail); the paginated batch list omits it (no per-row lookup).
Show child attributes
Show child attributes
Resolved item-scope lot selections as human-readable names. Present only on single-batch responses (create / batch detail); the paginated batch list omits it (no per-row lookup).
Show child attributes
Show child attributes
The per-warehouse sessions belonging to this batch.
Show child attributes
Show child attributes
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).
Present only on the create response when scope_type=item and some selected products/lots had no stock and were dropped from the count.