Zoho Inventory items API
Items Module
Zoho Inventory items 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 items. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 39 operations across 30 paths, and defines 115 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.
39 operations
30 paths
115 schemas
5 DELETE12 GET14 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory items API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 39
Across 30 paths, the API surfaces 39 operations — 5 DELETE, 12 GET, 14 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
items 39
Items Module
POST
/items
Create an item
GET
/items
List all the items
DELETE
/items
Delete multiple items
GET
/itemdetails
Bulk fetch item details
GET
/items/{item_id}
Retrieve an item
PUT
/items/{item_id}
Update an item
DELETE
/items/{item_id}
Delete an item
PUT
/item/{item_id}/customfields
Update custom field in existing items
POST
/items/{item_id}/image
Upload an item image
GET
/items/{item_id}/image
Retrieve an item image
DELETE
/items/{item_id}/image
Delete an item image
POST
/items/{item_id}/active
Mark as active
POST
/items/{item_id}/inactive
Mark as inactive
GET
/variants/{variant_id}/openingstock
Retrieve variant opening stock
PUT
/variants/{variant_id}/openingstock
Update variant opening stock
POST
/items/{item_id}/images
Upload multiple item images
DELETE
/items/{item_id}/images
Delete multiple item images
POST
/items/{item_id}/images/reorder
Reorder item images
POST
/items/{item_id}/backimage
Upload an item back image
DELETE
/items/{item_id}/backimage
Delete an item back image
PUT
/items/{item_id}/images/{image_id}/backimage
Mark an image as back image
POST
/items/active
Bulk mark items as active
POST
/items/inactive
Bulk mark items as inactive
POST
/items/ungroup
Ungroup items
POST
/items/enablestoragelocation
Enable storage location for items
POST
/items/disablestoragelocation
Disable storage location for items
PUT
/items/move/{item_id}
Move an item
PUT
/items/grouping/{group_id}
Group items
PUT
/items/{item_id}/locations/permissions
Update item location permissions
PUT
/items/locations/permissions
Bulk update item location permissions
POST
/items/{item_id}/serialnumber/validate
Validate serial numbers
POST
/items/{item_id}/serialnumber/validateandmap
Validate and map serial numbers
GET
/items/transactions/salesorders
List sales orders for an item
GET
/items/transactions/purchaseorders
List purchase orders for an item
GET
/items/transactions/invoices
List invoices for an item
GET
/items/transactions/deliverychallans
List delivery challans for an item
GET
/items/transactions/salesreceipts
List sales receipts for an item
GET
/items/transactions/moveorders
List move orders for an item
GET
/items/transactions/putaways
List putaways for an item
Schemas 115
The contract defines 115 schemas that model the data the API accepts and returns. The most detailed are item-response (53 properties), update-an-item-request (50 properties), create-an-item-request (38 properties), move-item-request (7 properties). Each schema is shown below with its type and property counts.
update-an-item-request
object
50 properties
1 required
attribute_option_name1
string
Name of the attribute's option.
update-an-item-response
object
3 properties
delete-an-item-image-response
object
2 properties
create-an-item-response
object
3 properties
ean
integer
Unique EAN value for the Item.
ungroup-items-response
object
2 properties
delete-item-images-response
object
2 properties
group_name
string
Name of product group
vendor_name
string
Name of the preferred Vendor for purchasing this item.
mark-as-active-response
object
2 properties
upload-item-back-image-response
object
2 properties
item_id
string
Unique ID generated by the server for the Item. This is used as an identifier.
get-variant-opening-stock-response
object
3 properties
location_available_stock
string
Available stock in your location.
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
documents
array
List of all the documents associated with the item
default_purchase_unit_conversion_id
string
Unique ID of the default purchase unit conversion. Applicable when unit conversion is enabled.
purchase_account_id
string
Unique ID generated by the server for the Purchase account.
purchase_rate
number
Purchase price of the Item.
list-all-the-items-response
object
3 properties
bulk-fetch-item-details-response
object
3 properties
list-item-move-orders-response
object
3 properties
custom_fields
array
List of custom fields associated with the item
group_id
string
Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.
item_type
string
Item type can be inventory, sales, purchases or salesandpurchases . If item is associated with a group, then type should be inventory .
item-response
object
53 properties
value
string
Value of the Custom Field
unitkey_code
string
Add Unit Key Code for your goods/services. Download the CFDI Catalogs.
update-an-item-customfield-response
object
2 properties
tax_specification
string
Type of tax. It can be intra or inter
inventory_account_id
string
Uniquq ID generated by the server for the Inventory account.
mark-as-inactive-response
object
2 properties
list-item-purchase-orders-response
object
3 properties
status
string
Status of the Item Group.
label
string
Label of the Custom Field
unit_group_name
string
Name of the unit group associated with the item. Applicable when unit conversion is enabled.
hsn_or_sac
string
HSN Code of the item
location_actual_available_stock
string
Actual available stock in your location.
upload-item-images-response
object
2 properties
move-item-response
object
2 properties
part_number
string
Part Number of the Item.
name
string
Name of the Item.
tax_percentage
number
Percentage of the Tax
group-items-response
object
2 properties
enable-storage-location-response
object
2 properties
is_primary
boolean
Mention whether the item is primary or not
group-items-request
object
Either groupname or groupid is required. Pass groupname to create a new group with up to 3 attributes and an items array, or pass groupid to associate the item…
7 properties
locations
array
List of locations.
location_id
string
Location ID
upload-item-image-response
object
2 properties
description
string
Description of the Item.
bulk-update-item-location-permissions-response
object
2 properties
purchase_description
string
The description for the purchase information. This will be displayed to the vendor in your purchase order.
reorder-item-images-response
object
2 properties
last_modified_time
string
Last Modified time of the Transaction
reorder-item-images-request
object
1 property
1 required
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
track_inventory
boolean
Boolean to indicate whether inventory tracking is enabled for the item.
bulk-delete-items-response
object
2 properties
validate-and-map-serial-numbers-response
object
2 properties
validate-serial-numbers-response
object
2 properties
list-item-putaways-response
object
3 properties
update-item-location-permissions-response
object
2 properties
disable-storage-location-response
object
2 properties
bulk-mark-items-inactive-response
object
2 properties
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.
is_taxable
boolean
Boolean to track the taxability of the item.
default_sales_unit_conversion_id
string
Unique ID of the default sales unit conversion. Applicable when unit conversion is enabled.
unit_id
string
Unique ID of the unit associated with the item.
list-item-delivery-challans-response
object
3 properties
update-variant-opening-stock-response
object
2 properties
unit
string
Unit of measurement for the item.
list-item-invoices-response
object
3 properties
image_type
string
Type of the image i.e., its file format.
created_time
string
Created Time of the Transaction
update-variant-opening-stock-request
object
The request body structure varies based on the item tracking configuration. When warehouse/location is not enabled, use top-level initialstock , initialstockra…
5 properties
create-an-item-request
object
38 properties
1 required
upc
integer
The 12 digit Unique Product Code (UPC) of the item.
rate
number
Sales price of the Item.
product_type
string
Type of the product. It can be goods or service
reorder_level
number
Reorder level of the item.
tax_id
string
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
delete-an-item-response
object
2 properties
is_linked_with_zohocrm
boolean
Denotes if the item is linked to Zoho CRM
validate-and-map-serial-numbers-request
object
5 properties
location_name
string
Name of the location
delete-item-back-image-response
object
2 properties
location_stock_on_hand
string
Current available stock in your location.
attribute_id1
string
Unique ID used by the server. This is used as an identifier.
isbn
string
Unique ISBN value for the Item.
unit_group_id
string
Unique ID of the unit group associated with the item. Applicable when unit conversion is enabled.
pricebook_rate
number
Pricelist rate applied on the item.
retrieve-an-item-response
object
3 properties
is_combo_product
boolean
purchase_account_name
string
Name of the Purchase Account
customfield_id
string
Unique ID of the custom field.
can_be_sold
boolean
Boolean to indicate whether the item can be sold.
can_be_purchased
boolean
Boolean to indicate whether the item can be purchased.
bulk-mark-items-active-response
object
2 properties
attribute_name1
string
Name of the attribute present in the Item Group.
image_name
string
Image name of the Item.
mark-image-as-back-image-response
object
2 properties
attribute_option_id1
string
Unique ID generated by the server for the attribute's options. This is used as an identifier.
item_tax_preferences
array
List of tax preferences of the item.
account_name
string
Name of the Sales Account.
list-item-sales-receipts-response
object
3 properties
move-item-request
object
7 properties
1 required
tax_type
string
Type of the Tax.
source
string
The source of the Item Group.
list-item-sales-orders-response
object
3 properties
tax_name
string
Name of the tax applied on the Item Group.
vendor_id
string
Unique ID generated by the server for the Vendor. This is used as an identifier.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
#items