Batches

Batches AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Batches help you track inventory items by batch numbers, manufacturing dates, and expiration dates.

Download Batches OpenAPI Document
End Points

Attribute

batch_id
string
Unique identifier of the batch.
item_id
string
Unique identifier of the item the batch belongs to.
batch_number
string
Batch number.
manufacturer_batch_number
string
Manufacturer-provided batch number.
manufactured_date
string
Manufacturing date of the batch.
expiry_date
string
Expiration date of the batch.
balance_quantity
float
Quantity currently available in the batch.
status
string
Status of the batch. Allowed values active and inactive.
batch_custom_fields
array
Custom fields configured for the batch.
Show Sub-Attributes arrow
custom_field_id
string
Unique identifier of the custom field.
label
string
Label of the custom field.
value
string
Value of the custom field.

Example

{ "batch_id": "6780203000001066694", "item_id": "6780203000001003147", "batch_number": "BTC-8900", "manufacturer_batch_number": "MFR-BTC-8900", "manufactured_date": "2026-05-12", "expiry_date": "2026-10-15", "balance_quantity": 0, "status": "active", "batch_custom_fields": [ { "custom_field_id": "6780203000000176175", "label": "Lot Code", "value": "LC-001" } ] }

List all batches AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List all batches available for a given item.
OAuth Scope : ERP.items.READ

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
item_id
string
(Required)
Unique identifier of the item to fetch batches for.
include_empty_batches
boolean
Include batches that have zero quantity. Allowed values true and false.
warehouse_id
string
Filter batches by warehouse ID.
location_id
string
Filter batches by location ID.
batch_ids
string
Comma-separated list of batch IDs to filter the response.
search_text
string
Search batches by batch number or manufacturer batch number.
status
string
Filter batches by status. Allowed values active and inactive.
filter_by
string
Filter batches by status, expiry, type, or stock. For example Status.All, Expiry.Expired, Stock.Empty.
sort_column
string
Column to sort the response by. Allowed values batch_number, external_batch_number, manufacturer_batch_number, manufactured_date, expiry_date, sales_rate, and label_rate.
sort_order
string
Order of sorting. Allowed values A for ascending and D for descending.
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/v3/items/batches?organization_id=10234695&item_id=6780203000000167467" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.in/erp/v3/items/batches?organization_id=10234695&item_id=6780203000000167467") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.in/erp/v3/items/batches?organization_id=10234695&item_id=6780203000000167467', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/erp/v3/items/batches?organization_id=10234695&item_id=6780203000000167467", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.in", "port": null, "path": "/erp/v3/items/batches?organization_id=10234695&item_id=6780203000000167467", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.in/erp/v3/items/batches?organization_id=10234695&item_id=6780203000000167467' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "batches": [ { "batch_id": "6780203000001066694", "batch_in_id": "6780203000001003281", "batch_number": "BTC-8900", "internal_batch_number": "", "external_batch_number": "MFR-BTC-8900", "manufacturer_batch_number": "MFR-BTC-8900", "manufacturer_date": "2026-05-12", "manufactured_date": "2026-05-12", "expiry_date": "2026-10-15", "in_quantity": 0, "balance_quantity": 0, "balance_quantity_unit": "", "location_id": "6780203000000093215", "associated_locations": [ { "location_id": "6780203000000093215", "in_quantity": 0, "balance_quantity": 0 } ], "batch_custom_fields": [ { "custom_field_id": "6780203000000176175", "label": "Lot Code", "value": "LC-001" } ], "status": "active" }, {...}, {...} ] }

Retrieve a batch AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Fetch the details of a specific batch.
OAuth Scope : ERP.items.READ

Path Parameters

batch_id
string
(Required)
Unique identifier of the batch.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.in/erp/v3/items/batches/6780203000000176162?organization_id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.in/erp/v3/items/batches/6780203000000176162?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.in/erp/v3/items/batches/6780203000000176162?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.in") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/erp/v3/items/batches/6780203000000176162?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.in", "port": null, "path": "/erp/v3/items/batches/6780203000000176162?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.in/erp/v3/items/batches/6780203000000176162?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "batch": { "batch_id": "6780203000001066694", "item_id": "6780203000001003147", "batch_number": "BTC-8900", "manufacturer_batch_number": "MFR-BTC-8900", "manufactured_date": "2026-05-12", "expiry_date": "2026-10-15", "balance_quantity": 0, "status": "active", "batch_custom_fields": [ { "custom_field_id": "6780203000000176175", "label": "Lot Code", "value": "LC-001" } ] } }