data
Zoho Inventory CLI for AI Agents
Use the Zoho Inventory CLI from KosmoKrator to call Zoho Inventory tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Zoho Inventory CLI Setup
Zoho Inventory can be configured headlessly with `kosmokrator integrations:configure zoho-inventory`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure zoho-inventory --set access_token="$ZOHO_INVENTORY_ACCESS_TOKEN" --set organization_id="$ZOHO_INVENTORY_ORGANIZATION_ID" --enable --read allow --write ask --json
kosmokrator integrations:doctor zoho-inventory --json
kosmokrator integrations:status --json Credentials
Authentication type: Manual OAuth token oauth2_manual_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | ZOHO_INVENTORY_ACCESS_TOKEN | Secret secret | yes | Access Token |
organization_id | ZOHO_INVENTORY_ORGANIZATION_ID | Text text | yes | Organization ID |
url | ZOHO_INVENTORY_URL | URL url | no | API Base URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call zoho-inventory.zoho_inventory_list_items '{"page":1,"per_page":1,"status":"example_status"}' --json kosmo integrations:zoho-inventory zoho_inventory_list_items '{"page":1,"per_page":1,"status":"example_status"}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs zoho-inventory --json
kosmo integrations:docs zoho-inventory.zoho_inventory_list_items --json
kosmo integrations:schema zoho-inventory.zoho_inventory_list_items --json
kosmo integrations:search "Zoho Inventory" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
zoho-inventory.zoho_inventory_list_items
List inventory items (products) from Zoho Inventory. Supports pagination and optional filtering by status (active, inactive, all).
read - Parameters
- page, per_page, status
kosmo integrations:call zoho-inventory.zoho_inventory_list_items '{"page":1,"per_page":1,"status":"example_status"}' --json kosmo integrations:zoho-inventory zoho_inventory_list_items '{"page":1,"per_page":1,"status":"example_status"}' --json zoho-inventory.zoho_inventory_get_item
Get detailed information about a specific inventory item (product) by its Zoho Inventory ID.
read - Parameters
- item_id
kosmo integrations:call zoho-inventory.zoho_inventory_get_item '{"item_id":"example_item_id"}' --json kosmo integrations:zoho-inventory zoho_inventory_get_item '{"item_id":"example_item_id"}' --json zoho-inventory.zoho_inventory_list_orders
List sales orders from Zoho Inventory. Supports pagination and optional filtering by status (draft, confirmed, void, open, invoiced, partially_invoiced, all).
read - Parameters
- page, per_page, status
kosmo integrations:call zoho-inventory.zoho_inventory_list_orders '{"page":1,"per_page":1,"status":"example_status"}' --json kosmo integrations:zoho-inventory zoho_inventory_list_orders '{"page":1,"per_page":1,"status":"example_status"}' --json zoho-inventory.zoho_inventory_get_order
Get detailed information about a specific sales order by its Zoho Inventory ID.
read - Parameters
- order_id
kosmo integrations:call zoho-inventory.zoho_inventory_get_order '{"order_id":"example_order_id"}' --json kosmo integrations:zoho-inventory zoho_inventory_get_order '{"order_id":"example_order_id"}' --json zoho-inventory.zoho_inventory_list_shipments
List shipments from Zoho Inventory. Supports pagination to browse through shipment records.
read - Parameters
- page, per_page
kosmo integrations:call zoho-inventory.zoho_inventory_list_shipments '{"page":1,"per_page":1}' --json kosmo integrations:zoho-inventory zoho_inventory_list_shipments '{"page":1,"per_page":1}' --json zoho-inventory.zoho_inventory_list_packages
List packages from Zoho Inventory. Supports pagination to browse through package records.
read - Parameters
- page, per_page
kosmo integrations:call zoho-inventory.zoho_inventory_list_packages '{"page":1,"per_page":1}' --json kosmo integrations:zoho-inventory zoho_inventory_list_packages '{"page":1,"per_page":1}' --json zoho-inventory.zoho_inventory_get_current_user
Get details of the currently authenticated Zoho Inventory user. Useful for verifying credentials and checking permissions.
read - Parameters
- none
kosmo integrations:call zoho-inventory.zoho_inventory_get_current_user '{}' --json kosmo integrations:zoho-inventory zoho_inventory_get_current_user '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
zoho-inventory.zoho_inventory_list_items 3 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_list_items --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of items per page, max 200 (default: 25). |
status | string | no | Filter by item status: active, inactive, all. |
zoho-inventory.zoho_inventory_get_item 1 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_get_item --json | Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | yes | The Zoho Inventory item ID. |
zoho-inventory.zoho_inventory_list_orders 3 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_list_orders --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of orders per page, max 200 (default: 25). |
status | string | no | Filter by order status: draft, confirmed, void, open, invoiced, partially_invoiced, all. |
zoho-inventory.zoho_inventory_get_order 1 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_get_order --json | Parameter | Type | Required | Description |
|---|---|---|---|
order_id | string | yes | The Zoho Inventory sales order ID. |
zoho-inventory.zoho_inventory_list_shipments 2 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_list_shipments --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of shipments per page, max 200 (default: 25). |
zoho-inventory.zoho_inventory_list_packages 2 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_list_packages --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (default: 1). |
per_page | integer | no | Number of packages per page, max 200 (default: 25). |
zoho-inventory.zoho_inventory_get_current_user 0 parameters
kosmo integrations:schema zoho-inventory.zoho_inventory_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.