Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zoho Inventory

Zoho Inventory batches API

Batches Module

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Inventory batches API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include batches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 10 operations across 6 paths, and defines 36 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

10 operations 6 paths 36 schemas 2 DELETE2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory batches API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

batches 10

Batches Module

POST
/items/batches
Create a batch
create_a_batch 1 param body → 201
GET
/items/batches
List all batches
list_batches 13 params → 200
DELETE
/items/batches
Bulk delete batches
bulk_delete_batches 2 params → 200
GET
/items/batches/{batch_id}
Retrieve a batch
retrieve_a_batch 2 params → 200
PUT
/items/batches/{batch_id}
Update a batch
update_a_batch 2 params body → 200
DELETE
/items/batches/{batch_id}
Delete a batch
delete_a_batch 2 params → 200
POST
/items/batches/{batch_id}/active
Mark a batch as active
mark_batch_as_active 2 params → 200
POST
/items/batches/{batch_id}/inactive
Mark a batch as inactive
mark_batch_as_inactive 2 params → 200
POST
/items/batches/active
Mark batches as active
mark_batches_as_active 2 params → 200
POST
/items/batches/inactive
Mark batches as inactive
mark_batches_as_inactive 2 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are list-batches-item (16 properties), batch-response (9 properties), create-a-batch-request (8 properties), update-a-batch-request (7 properties). Each schema is shown below with its type and property counts.

status
string
Status of the batch. Allowed values active and inactive .
batch-response
object
Details of a batch.
9 properties
label
string
Label of the custom field.
external_batch_number
string
External batch number from the manufacturer.
balance_quantity
number
Quantity currently available in the batch.
manufacturer_batch_number
string
Manufacturer-provided batch number.
associated_locations
array
Locations where stock for this batch is available, with the inward and balance quantity at each location.
create-a-batch-response
object
3 properties
item_id
string
Unique identifier of the item the batch belongs to.
mark-a-batch-as-inactive-response
object
2 properties
manufactured_date
string
Manufacturing date of the batch.
retrieve-a-batch-response
object
3 properties
update-a-batch-response
object
3 properties
label_rate
number
Label rate of the batch.
sales_rate
number
Sales rate of the batch.
in_quantity
number
Quantity received into the batch when stock was added.
internal_batch_number
string
Internal batch number generated by the system.
mark-batches-as-inactive-response
object
2 properties
list-all-batches-response
object
3 properties
mark-a-batch-as-active-response
object
2 properties
value
string
Value of the custom field.
batch_number
string
Batch number.
custom_field_id
string
Unique identifier of the custom field.
location_id
string
Unique identifier of the location associated with the batch.
create-a-batch-request
object
8 properties 2 required
delete-a-batch-response
object
2 properties
batch_id
string
Unique identifier of the batch.
expiry_date
string
Expiration date of the batch.
bulk-delete-batches-response
object
2 properties
list-batches-item
object
Details of a batch as returned in the list batches response.
16 properties
batch_in_id
string
Unique identifier of the inward batch entry created when stock was received.
balance_quantity_unit
string
Unit of measurement for the balance quantity.
mark-batches-as-active-response
object
2 properties
update-a-batch-request
object
7 properties
manufacturer_date
string
Manufacturing date of the batch. Legacy alias retained for backward compatibility; prefer manufactureddate .
batch_custom_fields
array
Custom fields configured for the batch.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-batches-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory bills API
AE Profile APIs.io
Zoho Inventory compositeitems API
AE Profile APIs.io
Zoho Inventory contact-persons API
AE Profile APIs.io
Zoho Inventory contacts API
AE Profile APIs.io
Zoho Inventory credit-notes API
AE Profile APIs.io
Zoho Inventory currency API
AE Profile APIs.io
Zoho Inventory customer-payments API
AE Profile APIs.io
Zoho Inventory delivery-challans API
AE Profile APIs.io
Zoho Inventory inventoryadjustments API
AE Profile APIs.io
Zoho Inventory invoices API
AE Profile APIs.io
Zoho Inventory itemgroups API
AE Profile APIs.io
Zoho Inventory items API
AE Profile APIs.io
#batches
← Back to Z APIs
API Details
ID
zoho-inventory:zoho-inventory-batches-api
Base URL
https://www.zohoapis.com/inventory/v1
Docs
https://www.zoho.com/inventory/api/v1/introduction/
Provider
Zoho Inventory
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network