API Docs
/
No Results Found
FAQ
Help Docs
All Resources
Items

Items

An item is the product that is offered for sale. Nature of the product could be physical or digital. Based on the type of your business, you can offer one or more goods/services. Your product can be either fixed priced or a subscription service. Each of this may fall under a separate pricing category or have add ons associated to them.

End Points
Create an item
List all the items
Bulk fetch item details
Update an item
Retrieve an item
Delete an item
Delete an item image
Mark as active
Mark as inactive

Attribute

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.
group_name
string
Name of product group
item_id
long
Unique ID generated by the server for the Item. This is used as an identifier.
name
string
Name of the Item.
unit
string
Unit of measurement for the item.
item_type
string
Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
product_type
string
Type of the product. It can be goods or service
is_taxable
boolean
Boolean to track the taxability of the item.
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
documents
array
List of all the documents associated with the item
description
string
Description of the Item.
tax_name
string
Name of the tax applied on the Item Group.
tax_percentage
double
Percentage of the Tax
tax_type
string
Type of the Tax.
purchase_account_id
long
Unique ID generated by the server for the Purchase account.
purchase_account_name
string
Name of the Purchase Account
account_name
string
Name of the Sales Account.
inventory_account_id
long
Uniquq ID generated by the server for the Inventory account.
attribute_id1
long
Unique ID used by the server. This is used as an identifier.
attribute_name1
string
Name of the attribute present in the Item Group.
status
string
Status of the Item Group.
source
string
The source of the Item Group.
rate
double
Sales price of the Item.
pricebook_rate
double
Pricelist rate applied on the item.
purchase_rate
double
Purchase price of the Item.
reorder_level
double
Reorder level of the item.
initial_stock
double
The opening stock of the item.
initial_stock_rate
double
The opening stock value of the item.
vendor_id
long
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
string
Name of the preferred Vendor for purchasing this item.
stock_on_hand
double
Stock available for a particular item.
available_stock
decimal
Stock based on Shipments and Receives
actual_available_stock
decimal
Stock based on Shipments and Receives minus ordered stock
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
long
The 12 digit Unique Product Code (UPC) of the item.
ean
long
Unique EAN value for the Item.
isbn
string
Unique ISBN value for the Item.
part_number
string
Part Number of the Item.
attribute_option_id1
long
Unique ID generated by the server for the attribute's options. This is used as an identifier.
attribute_option_name1
long
Name of the attribute's option.
image_id
long
Unique ID generated by the server for the item image. This is used as an identifier.
image_name
string
Image name of the Item.
purchase_description
string
The description for the purchase information. This will be displayed to the vendor in your purchase order.
image_type
string
Type of the image i.e., its file format.
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
tax_specification
string
🇮🇳 India
only
Type of tax. It can be intra or inter
hsn_or_sac
string
🇮🇳 India
only
HSN Code of the item
sat_item_key_code
string
🇲🇽 Mexico
only
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
unitkey_code
string
🇲🇽 Mexico
only
Add Unit Key Code for your goods/services. Download the CFDI Catalogs.
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field

Example

{ "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "documents": [ "string" ], "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "source": "string", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }

Create an item

Creates a new item in Zoho Inventory.
OAuth Scope : ZohoInventory.items.CREATE

Arguments

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.
group_name
string
Name of product group
unit
string
Unit of measurement for the item.
documents
array
List of all the documents associated with the item
item_type
string
Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
product_type
string
Type of the product. It can be goods or service
is_taxable
boolean
Boolean to track the taxability of the item.
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
description
string
Description of the Item.
purchase_account_id
long
Unique ID generated by the server for the Purchase account.
inventory_account_id
long
Uniquq ID generated by the server for the Inventory account.
attribute_name1
string
Name of the attribute present in the Item Group.
name
string
(Required)
Name of the Item.
rate
double
Sales price of the Item.
purchase_rate
double
Purchase price of the Item.
reorder_level
double
Reorder level of the item.
initial_stock
double
The opening stock of the item.
initial_stock_rate
double
The opening stock value of the item.
vendor_id
long
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
string
Name of the preferred Vendor for purchasing this item.
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
long
The 12 digit Unique Product Code (UPC) of the item.
ean
long
Unique EAN value for the Item.
isbn
string
Unique ISBN value for the Item.
part_number
string
Part Number of the Item.
attribute_option_name1
long
Name of the attribute's option.
purchase_description
string
The description for the purchase information. This will be displayed to the vendor in your purchase order.
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
tax_specification
string
🇮🇳 India
only
Type of tax. It can be intra or inter
hsn_or_sac
string
🇮🇳 India
only
HSN Code of the item
sat_item_key_code
string
🇲🇽 Mexico
only
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
unitkey_code
string
🇲🇽 Mexico
only
Add Unit Key Code for your goods/services. Download the CFDI Catalogs.
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items?organization_id=10234695" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items?organization_id=10234695") .post(body) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/inventory/v1/items?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.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/inventory/v1/items?organization_id=10234695", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/items?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; 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.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request POST \ --url 'https://www.zohoapis.com/inventory/v1/items?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "group_id": 4815000000044220, "group_name": "Bags", "unit": "qty", "documents": [ "string" ], "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "purchase_account_id": 4815000000035003, "inventory_account_id": 4815000000035001, "attribute_name1": "Small", "name": "Bags-small", "rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_name1": "Small", "purchase_description": "Purchase description", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }

Response Example

{ "code": 0, "message": "The item has been added.", "item": { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "documents": [ "string" ], "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "source": "string", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] } }

List all the items

Lists all the items present in Zoho Inventory.
OAuth Scope : ZohoInventory.items.READ

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items?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.com/inventory/v1/items?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.com/inventory/v1/items?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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/items?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.com", "port": null, "path": "/inventory/v1/items?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.com/inventory/v1/items?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "items": [ { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "status": "active", "source": "string", "is_linked_with_zohocrm": false, "item_type": "inventory", "description": "description", "rate": 6, "is_taxable": true, "tax_id": 4815000000044043, "tax_name": "Sales", "tax_percentage": 12, "purchase_description": "Purchase description", "purchase_rate": 6, "is_combo_product": false, "product_type": "goods", "attribute_id1": 4815000000044112, "attribute_name1": "Small", "reorder_level": 5, "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_name": "bag_s.jpg", "image_type": "jpg", "created_time": "2013-01-24", "last_modified_time": "2013-01-24", "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }, {...}, {...} ] }

Bulk fetch item details

Fetch item details for the mentioned item IDs
OAuth Scope : ZohoInventory.items.READ

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/itemdetails?item_ids=4815000000044208,4815000000044274,4815000000044340&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.com/inventory/v1/itemdetails?item_ids=4815000000044208%2C4815000000044274%2C4815000000044340&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.com/inventory/v1/itemdetails?item_ids=4815000000044208%2C4815000000044274%2C4815000000044340&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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/itemdetails?item_ids=4815000000044208%2C4815000000044274%2C4815000000044340&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.com", "port": null, "path": "/inventory/v1/itemdetails?item_ids=4815000000044208%2C4815000000044274%2C4815000000044340&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.com/inventory/v1/itemdetails?item_ids=4815000000044208%2C4815000000044274%2C4815000000044340&organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "items": [ { "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }, {...}, {...} ] }

Update an item

Update the details of an item.
OAuth Scope : ZohoInventory.items.UPDATE

Arguments

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.
group_name
string
Name of product group
unit
string
Unit of measurement for the item.
item_type
string
Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory.
product_type
string
Type of the product. It can be goods or service
is_taxable
boolean
Boolean to track the taxability of the item.
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
description
string
Description of the Item.
tax_name
string
Name of the tax applied on the Item Group.
tax_percentage
double
Percentage of the Tax
tax_type
string
Type of the Tax.
purchase_account_id
long
Unique ID generated by the server for the Purchase account.
purchase_account_name
string
Name of the Purchase Account
account_name
string
Name of the Sales Account.
inventory_account_id
long
Uniquq ID generated by the server for the Inventory account.
attribute_id1
long
Unique ID used by the server. This is used as an identifier.
attribute_name1
string
Name of the attribute present in the Item Group.
status
string
Status of the Item Group.
source
string
The source of the Item Group.
name
string
(Required)
Name of the Item.
rate
double
Sales price of the Item.
pricebook_rate
double
Pricelist rate applied on the item.
purchase_rate
double
Purchase price of the Item.
reorder_level
double
Reorder level of the item.
initial_stock
double
The opening stock of the item.
initial_stock_rate
double
The opening stock value of the item.
vendor_id
long
Unique ID generated by the server for the Vendor. This is used as an identifier.
vendor_name
string
Name of the preferred Vendor for purchasing this item.
stock_on_hand
double
Stock available for a particular item.
sku
string
The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.
upc
long
The 12 digit Unique Product Code (UPC) of the item.
ean
long
Unique EAN value for the Item.
isbn
string
Unique ISBN value for the Item.
part_number
string
Part Number of the Item.
attribute_option_id1
long
Unique ID generated by the server for the attribute's options. This is used as an identifier.
attribute_option_name1
long
Name of the attribute's option.
image_id
long
Unique ID generated by the server for the item image. This is used as an identifier.
image_name
string
Image name of the Item.
purchase_description
string
The description for the purchase information. This will be displayed to the vendor in your purchase order.
image_type
string
Type of the image i.e., its file format.
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
long
Unique ID generated by the server for the tax associated with the item. This is used a unique identifier.
tax_specification
string
🇮🇳 India
only
Type of tax. It can be intra or inter
hsn_or_sac
string
🇮🇳 India
only
HSN Code of the item
sat_item_key_code
string
🇲🇽 Mexico
only
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
unitkey_code
string
🇲🇽 Mexico
only
Add Unit Key Code for your goods/services. Download the CFDI Catalogs.
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items/4815000000044208?organization_id=10234695" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items/4815000000044208?organization_id=10234695") .put(body) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'PUT', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/inventory/v1/items/4815000000044208?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.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PUT", "/inventory/v1/items/4815000000044208?organization_id=10234695", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "PUT", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/items/4815000000044208?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; 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.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request PUT \ --url 'https://www.zohoapis.com/inventory/v1/items/4815000000044208?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "group_id": 4815000000044220, "group_name": "Bags", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "source": "string", "name": "Bags-small", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }

Response Example

{ "code": 0, "message": "Item details have been updated", "item": { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "documents": [ "string" ], "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "source": "string", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] } }

Retrieve an item

Fetches the details for an existing item.
OAuth Scope : ZohoInventory.items.READ

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items/4815000000044208?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.com/inventory/v1/items/4815000000044208?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.com/inventory/v1/items/4815000000044208?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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/items/4815000000044208?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.com", "port": null, "path": "/inventory/v1/items/4815000000044208?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.com/inventory/v1/items/4815000000044208?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "item": { "group_id": 4815000000044220, "group_name": "Bags", "item_id": 4815000000044208, "name": "Bags-small", "unit": "qty", "item_type": "inventory", "product_type": "goods", "is_taxable": true, "tax_id": 4815000000044043, "description": "description", "tax_name": "Sales", "tax_percentage": 12, "tax_type": "Service Tax", "purchase_account_id": 4815000000035003, "purchase_account_name": "Cost of Goods Sold", "account_name": "Sales", "inventory_account_id": 4815000000035001, "attribute_id1": 4815000000044112, "attribute_name1": "Small", "status": "active", "source": "string", "rate": 6, "pricebook_rate": 6, "purchase_rate": 6, "reorder_level": 5, "initial_stock": 50, "initial_stock_rate": 500, "vendor_id": 4815000000044080, "vendor_name": "Molly", "stock_on_hand": 50, "available_stock": 2, "actual_available_stock": 2, "sku": "SK123", "upc": 111111111111, "ean": 111111111112, "isbn": 111111111113, "part_number": 111111111114, "attribute_option_id1": 4815000000044214, "attribute_option_name1": "Small", "image_id": 2077500000000002000, "image_name": "bag_s.jpg", "purchase_description": "Purchase description", "image_type": "jpg", "item_tax_preferences": [ { "tax_id": 4815000000044043, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] } }

Delete an item

Deletes an existing item from Zoho Inventory.
OAuth Scope : ZohoInventory.items.DELETE

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items/4815000000044208?organization_id=10234695" type: DELETE headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items/4815000000044208?organization_id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/items/4815000000044208?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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/inventory/v1/items/4815000000044208?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/items/4815000000044208?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 DELETE \ --url 'https://www.zohoapis.com/inventory/v1/items/4815000000044208?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The item has been deleted." }

Delete an item image

Deletes the image associated for an item in Zoho Inventory.
OAuth Scope : ZohoInventory.items.DELETE

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items/4815000000044208/image?organization_id=10234695" type: DELETE headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items/4815000000044208/image?organization_id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/items/4815000000044208/image?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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/inventory/v1/items/4815000000044208/image?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/items/4815000000044208/image?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 DELETE \ --url 'https://www.zohoapis.com/inventory/v1/items/4815000000044208/image?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The item image has been deleted." }

Mark as active

Changes the status of an item to active.
OAuth Scope : ZohoInventory.items.CREATE

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items/4815000000044208/active?organization_id=10234695" type: POST headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items/4815000000044208/active?organization_id=10234695") .post(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/items/4815000000044208/active?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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("POST", "/inventory/v1/items/4815000000044208/active?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/items/4815000000044208/active?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 POST \ --url 'https://www.zohoapis.com/inventory/v1/items/4815000000044208/active?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The item has been marked as Active." }

Mark as inactive

Mark an item as inactive.
OAuth Scope : ZohoInventory.items.CREATE

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/items/4815000000044208/inactive?organization_id=10234695" type: POST headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items/4815000000044208/inactive?organization_id=10234695") .post(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/items/4815000000044208/inactive?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.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("POST", "/inventory/v1/items/4815000000044208/inactive?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/items/4815000000044208/inactive?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 POST \ --url 'https://www.zohoapis.com/inventory/v1/items/4815000000044208/inactive?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The item has been marked as Inactive." }