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

Items

Items are the products or services that you sell to your customers.

Download Items OpenAPI Document
Download
Download Zoho Books OpenAPI Document
End Points
Create an Item
Update an item using a custom field's unique value
List items
Update an item
Get an item
Delete an item
Update custom field in existing items
Mark as active
Mark as inactive

Attribute

item_id
string
ID of the item.
name
string
Name of the item. Max-length [100]
status
string
Status of the item. It can be active or inactive
description
string
Description for the item. Max-length [2000]
rate
double
Price of the item.
unit
string
If there is a measurement unit for the items you are adding.
tax_id
string
Not applicable 🇺🇸 United States
, 🇮🇳 India
ID of the tax to be associated to the item.
purchase_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the sales tax rule
tax_name
string
hsn_or_sac
string
🇮🇳 India
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
HSN Code
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.
tax_percentage
string
Percent of the tax.
tax_type
string
Type of the tax.
sku
string
SKU value of item,should be unique throughout the product
product_type
string
Specify the type of an item. Allowed values:
goods or service or digital_service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
string
🇮🇳 India
only
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field
locations
array
Show Sub-Attributes arrow
location_id
string
Location ID
location_name
string
Name of the location
status
string
Status of the item. It can be active or inactive
is_primary
boolean
Mention whether the item is primary or not
location_stock_on_hand
string
Current available stock in your location.
location_available_stock
string
Available stock in your location.
location_actual_available_stock
string
Actual available stock in your location.

Example

{ "item_id": 45667789900, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_name": "Sales Tax", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "tax_percentage": "70%", "tax_type": "tax", "sku": "s12345", "product_type": "goods", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ], "locations": [ { "location_id": "460000000038080", "location_name": "", "status": "active", "is_primary": false, "location_stock_on_hand": "", "location_available_stock": "", "location_actual_available_stock": "" } ] }

Create an Item

Create a new item.
OAuth Scope : ZohoBooks.settings.CREATE

Arguments

name
string
(Required)
Name of the item. Max-length [100]
rate
double
(Required)
Price of the item.
description
string
Description for the item. Max-length [2000]
tax_id
string
Not applicable 🇺🇸 United States
, 🇮🇳 India
ID of the tax to be associated to the item.
locations
array
Show Sub-Attributes arrow
location_id
string
Location ID
initial_stock
string
Opening stock of the item.
initial_stock_rate
string
Unit price of the opening stock.
purchase_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the sales tax rule
tax_percentage
string
Percent of the tax.
sku
string
SKU value of item,should be unique throughout the product
product_type
string
Specify the type of an item. Allowed values:
goods or service or digital_service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods
hsn_or_sac
string
🇮🇳 India
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
HSN Code
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.
is_taxable
boolean
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Boolean to track the taxability of the item.
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
ID of the tax exemption. Mandatory, if is_taxable is false.
purchase_tax_exemption_id
string
🇰🇪 Kenya
, 🇿🇦 South Africa
only
ID of the purchase tax exemption. Mandatory, if is_taxable is false.
account_id
string
ID of the account to which the item has to be associated with.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Max-length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]
item_type
string
Type of the item. Allowed values: sales,purchases,sales_and_purchases and inventory. Default value will be sales.
purchase_description
string
Purchase description for the item.
purchase_rate
string
Purchase price of the item.
purchase_account_id
string
ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.
inventory_account_id
string
ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
vendor_id
string
Preferred vendor ID.
reorder_level
string
Reorder level of the item.
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
string
🇮🇳 India
only
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field

Query Parameters

organization_id
string
(Required)
ID of the organization

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/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/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
{ "name": "Hard Drive", "rate": 120, "description": "500GB", "tax_id": 982000000037049, "locations": [ { "location_id": "460000000038080", "initial_stock": " ", "initial_stock_rate": " " } ], "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_percentage": "70%", "sku": "s12345", "product_type": "goods", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "is_taxable": true, "tax_exemption_id": "string", "purchase_tax_exemption_id": "string", "account_id": " ", "avatax_tax_code": 982000000037049, "avatax_use_code": 982000000037049, "item_type": " ", "purchase_description": " ", "purchase_rate": " ", "purchase_account_id": " ", "inventory_account_id": " ", "vendor_id": " ", "reorder_level": " ", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }

Response Example

{ "code": 0, "message": "The item has been added.", "item": { "item_id": 45667789900, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_name": "Sales Tax", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "tax_percentage": "70%", "tax_type": "tax", "sku": "s12345", "product_type": "goods", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ], "locations": [ { "location_id": "460000000038080", "location_name": "", "status": "active", "is_primary": false, "location_stock_on_hand": "", "location_available_stock": "", "location_actual_available_stock": "" } ] } }

Update an item using a custom field's unique value

A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update an item by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding item will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing items, a new item will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.settings.UPDATE

Arguments

name
string
(Required)
Name of the item. Max-length [100]
rate
double
(Required)
Price of the item.
description
string
Description for the item. Max-length [2000]
tax_id
string
Not applicable 🇺🇸 United States
, 🇮🇳 India
ID of the tax to be associated to the item.
purchase_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the sales tax rule
tax_percentage
string
Percent of the tax.
hsn_or_sac
string
🇮🇳 India
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
HSN Code
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.
sku
string
SKU value of item,should be unique throughout the product
product_type
string
Specify the type of an item. Allowed values:
goods or service or digital_service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods
is_taxable
boolean
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Boolean to track the taxability of the item.
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
ID of the tax exemption. Mandatory, if is_taxable is false.
purchase_tax_exemption_id
string
🇰🇪 Kenya
, 🇿🇦 South Africa
only
ID of the purchase tax exemption. Mandatory, if is_taxable is false.
account_id
string
ID of the account to which the item has to be associated with.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Max-length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]
item_type
string
Type of the item. Allowed values: sales,purchases,sales_and_purchases and inventory. Default value will be sales.
purchase_description
string
Purchase description for the item.
purchase_rate
string
Purchase price of the item.
purchase_account_id
string
ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.
inventory_account_id
string
ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
vendor_id
string
Preferred vendor ID.
reorder_level
string
Reorder level of the item.
locations
array
Show Sub-Attributes arrow
location_id
string
Location ID
initial_stock
string
Opening stock of the item.
initial_stock_rate
string
Unit price of the opening stock.
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
string
🇮🇳 India
only
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field

Query Parameters

organization_id
string
(Required)
ID of the organization

Headers

X-Unique-Identifier-Key
string
(Required)
Unique CustomField Api Name
X-Unique-Identifier-Value
string
(Required)
Unique CustomField Value
X-Upsert
boolean
If there is no record is found unique custom field value , will create new invoice

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("X-Unique-Identifier-Key", "cf_unique_cf"); headers_data.put("X-Unique-Identifier-Value", "unique Value"); headers_data.put("X-Upsert", "true"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/items?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/books/v3/items?organization_id=10234695") .put(body) .addHeader("X-Unique-Identifier-Key", "cf_unique_cf") .addHeader("X-Unique-Identifier-Value", "unique Value") .addHeader("X-Upsert", "true") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'PUT', headers: { 'X-Unique-Identifier-Key': 'cf_unique_cf', 'X-Unique-Identifier-Value': 'unique Value', 'X-Upsert': 'true', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/books/v3/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 = { 'X-Unique-Identifier-Key': "cf_unique_cf", 'X-Unique-Identifier-Value': "unique Value", 'X-Upsert': "true", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PUT", "/books/v3/items?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": "/books/v3/items?organization_id=10234695", "headers": { "X-Unique-Identifier-Key": "cf_unique_cf", "X-Unique-Identifier-Value": "unique Value", "X-Upsert": "true", "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/books/v3/items?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'X-Unique-Identifier-Key: cf_unique_cf' \ --header 'X-Unique-Identifier-Value: unique Value' \ --header 'X-Upsert: true' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "name": "Hard Drive", "rate": 120, "description": "500GB", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_percentage": "70%", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "sku": "s12345", "product_type": "goods", "is_taxable": true, "tax_exemption_id": "string", "purchase_tax_exemption_id": "string", "account_id": " ", "avatax_tax_code": 982000000037049, "avatax_use_code": 982000000037049, "item_type": " ", "purchase_description": " ", "purchase_rate": " ", "purchase_account_id": " ", "inventory_account_id": " ", "vendor_id": " ", "reorder_level": " ", "locations": [ { "location_id": "460000000038080", "initial_stock": " ", "initial_stock_rate": " " } ], "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }

Response Example

{ "code": 0, "message": "Item details have been saved.", "item": { "item_id": 45667789900, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "tax", "sku": "s12345", "product_type": "goods", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "locations": [ { "location_id": "460000000038080", "location_name": "", "status": "active", "is_primary": false, "location_stock_on_hand": "", "location_available_stock": "", "location_actual_available_stock": "" } ] } }

List items

Get the list of all active items with pagination.
OAuth Scope : ZohoBooks.settings.READ

Query Parameters

organization_id
string
(Required)
ID of the organization
name
string
Search items by name. Max-length [100]. Variants: name_startswith and name_contains
description
string
Search items by description. Max-length [100]. Variants: description_startswith and description_contains
rate
string
Search items by rate. Variants: rate_less_than, rate_less_equals, rate_greater_than and rate_greater_equals
tax_id
string
Search items by tax id.
tax_name
string
is_taxable
boolean
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
only
Boolean to track the taxability of the item.
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
only
ID of the tax exemption. Mandatory, if is_taxable is false.
account_id
string
ID of the account to which the item has to be associated with.
filter_by
string
Filter items by status. Allowed Values: Status.All, Status.Active and Status.Inactive
search_text
string
Search items by name or description. Max-length [100]
sort_column
string
Sort items. Allowed Values: name, rate and tax_name
sat_item_key_code
string
🇲🇽 Mexico
only
SAT Item key code
unitkey_code
string
🇲🇽 Mexico
only
SAT Unit code
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/items?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "items": [ { "item_id": 45667789900, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "tax", "sku": "s12345", "product_type": "goods", "sat_item_key_code": "string", "unitkey_code": "string", "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Items", "sort_column": "string", "sort_order": "A" } }

Update an item

Update the details of an item.
OAuth Scope : ZohoBooks.settings.UPDATE

Arguments

name
string
(Required)
Name of the item. Max-length [100]
rate
double
(Required)
Price of the item.
description
string
Description for the item. Max-length [2000]
tax_id
string
Not applicable 🇺🇸 United States
, 🇮🇳 India
ID of the tax to be associated to the item.
purchase_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Id of the sales tax rule
tax_percentage
string
Percent of the tax.
hsn_or_sac
string
🇮🇳 India
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
HSN Code
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.
sku
string
SKU value of item,should be unique throughout the product
product_type
string
Specify the type of an item. Allowed values:
goods or service or digital_service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods
is_taxable
boolean
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
Boolean to track the taxability of the item.
tax_exemption_id
string
🇮🇳 India
, 🇺🇸 United States
, 🇲🇽 Mexico
, 🇰🇪 Kenya
, 🇿🇦 South Africa
only
ID of the tax exemption. Mandatory, if is_taxable is false.
purchase_tax_exemption_id
string
🇰🇪 Kenya
, 🇿🇦 South Africa
only
ID of the purchase tax exemption. Mandatory, if is_taxable is false.
account_id
string
ID of the account to which the item has to be associated with.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Max-length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]
item_type
string
Type of the item. Allowed values: sales,purchases,sales_and_purchases and inventory. Default value will be sales.
purchase_description
string
Purchase description for the item.
purchase_rate
string
Purchase price of the item.
purchase_account_id
string
ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.
inventory_account_id
string
ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
vendor_id
string
Preferred vendor ID.
reorder_level
string
Reorder level of the item.
locations
array
Show Sub-Attributes arrow
location_id
string
Location ID
initial_stock
string
Opening stock of the item.
initial_stock_rate
string
Unit price of the opening stock.
item_tax_preferences
array
🇮🇳 India
only
Show Sub-Attributes arrow
tax_id
string
🇮🇳 India
only
ID of the tax to be associated to the item.
tax_specification
string
🇮🇳 India
only
Set whether the tax type is intra/interstate
custom_fields
array
Custom fields for an item.
Show Sub-Attributes arrow
customfield_id
long
value
string
Value of the Custom Field

Path Parameters

item_id
string
(Required)
Unique identifier of the item.

Query Parameters

organization_id
string
(Required)
ID of the organization

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/books/v3/items/45667789900?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/books/v3/items/45667789900?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/books/v3/items/45667789900?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", "/books/v3/items/45667789900?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": "/books/v3/items/45667789900?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/books/v3/items/45667789900?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
{ "name": "Hard Drive", "rate": 120, "description": "500GB", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_percentage": "70%", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "sku": "s12345", "product_type": "goods", "is_taxable": true, "tax_exemption_id": "string", "purchase_tax_exemption_id": "string", "account_id": " ", "avatax_tax_code": 982000000037049, "avatax_use_code": 982000000037049, "item_type": " ", "purchase_description": " ", "purchase_rate": " ", "purchase_account_id": " ", "inventory_account_id": " ", "vendor_id": " ", "reorder_level": " ", "locations": [ { "location_id": "460000000038080", "initial_stock": " ", "initial_stock_rate": " " } ], "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "custom_fields": [ { "customfield_id": "46000000012845", "value": "Normal" } ] }

Response Example

{ "code": 0, "message": "Item details have been saved.", "item": { "item_id": 45667789900, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "tax", "sku": "s12345", "product_type": "goods", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "locations": [ { "location_id": "460000000038080", "location_name": "", "status": "active", "is_primary": false, "location_stock_on_hand": "", "location_available_stock": "", "location_actual_available_stock": "" } ] } }

Get an item

Details of an existing item.
OAuth Scope : ZohoBooks.settings.READ

Path Parameters

item_id
string
(Required)
Unique identifier of the item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/items/45667789900?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/books/v3/items/45667789900?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/books/v3/items/45667789900?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", "/books/v3/items/45667789900?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": "/books/v3/items/45667789900?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/books/v3/items/45667789900?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "item": { "item_id": 45667789900, "name": "Hard Drive", "status": "active", "description": "500GB", "rate": 120, "unit": "100GB", "hsn_or_sac": "string", "sat_item_key_code": "string", "unitkey_code": "string", "tax_id": 982000000037049, "purchase_tax_rule_id": 127919000000106780, "sales_tax_rule_id": 127919000000106780, "tax_name": "Sales Tax", "tax_percentage": "70%", "tax_type": "tax", "sku": "s12345", "product_type": "goods", "item_tax_preferences": [ { "tax_id": 982000000037049, "tax_specification": "intra" } ], "locations": [ { "location_id": "460000000038080", "location_name": "", "status": "active", "is_primary": false, "location_stock_on_hand": "", "location_available_stock": "", "location_actual_available_stock": "" } ] } }

Delete an item

Delete the item created.items that are part of transaction cannot be deleted.
OAuth Scope : ZohoBooks.settings.DELETE

Path Parameters

item_id
string
(Required)
Unique identifier of the item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/items/45667789900?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/books/v3/items/45667789900?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/books/v3/items/45667789900?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", "/books/v3/items/45667789900?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": "/books/v3/items/45667789900?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/books/v3/items/45667789900?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Update custom field in existing items

Update the value of the custom field in existing items.
OAuth Scope : ZohoBooks.settings.UPDATE

Arguments

customfield_id
long
value
string
Value of the Custom Field

Path Parameters

item_id
string
(Required)
Unique identifier of the item.

Query Parameters

organization_id
string
(Required)
ID of the organization

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/books/v3/item/45667789900/customfields?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/books/v3/item/45667789900/customfields?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/books/v3/item/45667789900/customfields?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", "/books/v3/item/45667789900/customfields?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": "/books/v3/item/45667789900/customfields?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/books/v3/item/45667789900/customfields?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
[ { "customfield_id": "46000000012845", "value": "Normal" } ]

Response Example

{ "code": 0, "message": "Custom Fields Updated Successfully" }

Mark as active

Mark an inactive item as active.
OAuth Scope : ZohoBooks.settings.CREATE

Path Parameters

item_id
string
(Required)
Unique identifier of the item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/items/45667789900/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/books/v3/items/45667789900/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/books/v3/items/45667789900/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", "/books/v3/items/45667789900/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": "/books/v3/items/45667789900/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/books/v3/items/45667789900/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 active item as inactive.
OAuth Scope : ZohoBooks.settings.CREATE

Path Parameters

item_id
string
(Required)
Unique identifier of the item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/items/45667789900/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/books/v3/items/45667789900/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/books/v3/items/45667789900/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", "/books/v3/items/45667789900/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": "/books/v3/items/45667789900/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/books/v3/items/45667789900/inactive?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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