List cycle count batches
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches")
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{
"data": [
{
"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
}Cycle Counts
List cycle count batches
Paginated, filterable batch list — the same dashboard list the internal UI shows, exposed externally. Each batch includes its per-warehouse sessions with summary stats only; items are never embedded here (use the per-session items endpoint).
GET
/
pickflow
/
cycle-counts
/
batches
List cycle count batches
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/cycle-counts/batches")
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{
"data": [
{
"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
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
Matches batches with at least one session in any of these statuses.
Available options:
draft, in_progress, pending_review, posted, cancelled Required range:
1 <= x <= 100Response
Paginated list of batches, each with its per-warehouse sessions.
Show child attributes
Show child attributes
⌘I