Zoho Inventory itemgroups 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 itemgroups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes
7 operations
across 4 paths,
and defines 58 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.
7 operations4 paths58 schemas1 DELETE2 GET3 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 itemgroups API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
itemgroups 7
ItemGroups Module
POST
/itemgroups
Create an Item Group
create_item_group1 parambody→ 201
GET
/itemgroups
List all Item Groups
list_item_groups3 params→ 200
GET
/itemgroups/{itemgroup_id}
Retrieve an Item Group
get_item_group2 params→ 200
PUT
/itemgroups/{itemgroup_id}
Update an Item Group
update_item_group2 paramsbody→ 200
DELETE
/itemgroups/{itemgroup_id}
Delete an Item Group
delete_item_group2 params→ 200
POST
/itemgroups/{itemgroup_id}/active
Mark as Active
mark_item_group_active2 params→ 200
POST
/itemgroups/{itemgroup_id}/inactive
Mark as Inactive.
mark_item_group_inactive2 params→ 200
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are create-an-item-group-response (24 properties), retrieve-an-item-group-response (24 properties), update-an-item-group-response (21 properties), update-an-item-group-request (12 properties). Each schema is shown below with its type and property counts.
attribute_option_name1
integer
Name of the attribute's option.
last_modified_time
string
Last Modified time of the Transaction
brand
string
Brand of the Item Group.
status
string
Status of the Item Group.
tax_id
string
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
create-an-item-group-response
object
24 properties
ean
integer
Unique EAN value for the Item.
label
string
Label of the Custom Field
group_name
string
Name of the Item Group.
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
vendor_name
string
Name of the preferred Vendor for purchasing this item.
attribute_id1
string
Unique ID used by the server. This is used as an identifier.
available_stock
number
Stock based on Shipments and Receives
isbn
string
Unique ISBN value for the Item.
item_id
string
Unique ID generated by the server for the Item. This is used as an identifier.
mark-as-active-response
object
2 properties
update-an-item-group-request
object
12 properties6 required
attributes
array
All the attributes present in the Item Group. Each attribute will have its own option.
part_number
string
Part Number of the Item.
name
string
Name of the Item.
tax_percentage
number
Percentage of the Tax
documents
array
The documents associated with the items
create-an-item-group-request
object
9 properties2 required
purchase_rate
number
Purchase price of the Item.
image_id
string
Unique ID generated by the server for the Item image. This is used as an identifier.
initial_stock_rate
number
The opening stock value of the item.
initial_stock
number
The opening stock of the item.
vendor_id
string
Unique ID generated by the server for the Vendor. This is used as an identifier.
custom_fields
array
List of custom fields associated with the item group
customfield_id
string
Unique ID of the custom field.
group_id
string
Unique ID generated by the server. This is used an a unique identifier.
is_taxable
boolean
Boolean to track the taxability of the item.
manufacturer
string
Manufacturer of Item Group.
value
string
Value of the Custom Field
update-an-item-group-response
object
21 properties
delete-an-item-group-response
object
2 properties
attribute_name1
string
Name of the attribute present in the Item Group.
image_name
string
Name of the Item image.
attribute_option_id1
string
Unique ID generated by the server for the attribute's options. This is used as an identifier.
actual_available_stock
number
Stock based on Shipments and Receives minus ordered stock
unit
string
Unit of measurement of the Item Group.
created_time
string
Created Time of the Transaction
image_type
string
Type of the image i.e., its file format.
tax_type
string
Type of the Tax.
source
string
The source of the Item Group.
description
string
Description of the Item Group.
options
array
The options present for each attribute.
retrieve-an-item-group-response
object
24 properties
upc
integer
The 12 digit Unique Product Code (UPC) of the item.
stock_on_hand
number
Stock available for a particular item.
rate
number
Sales price of the Item.
tax_name
string
Name of the tax applied on the Item Group.
product_type
string
Type of the product.
list-all-item-groups-response
object
3 properties
mark-as-inactive-response
object
2 properties
id
string
Unique ID generated by the server for the attribute. This is used as an identifier.
tax_exemption_id
string
reorder_level
number
Reorder level of the item.
Specification
The full machine-readable OpenAPI contract behind this narrative.
