Items
Items are the products or services that you sell to your customers.
End Points
Create an Item
List items
Update an item
Get an item
Delete an item
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
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽
Mexico
only
Id of the sales tax rule
tax_name
string
hsn_or_sac
string
🇮🇳
India
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. item_tax_preferences
array
🇮🇳
India
only
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
warehouses
array
warehouse_id
string
Enter warehouse ID
warehouse_name
string
Enter warehouse name
status
string
Status of the item. It can be
active or inactive is_primary
boolean
Mention whether the item is primary or not
warehouse_stock_on_hand
string
Current available stock in your warehouse.
warehouse_available_stock
string
Available stock in your warehouse.
warehouse_actual_available_stock
string
Actual available stock in your warehouse.
{
"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"
}
],
"warehouses": [
{
"warehouse_id": "",
"warehouse_name": "",
"status": "active",
"is_primary": false,
"warehouse_stock_on_hand": "",
"warehouse_available_stock": "",
"warehouse_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.
purchase_tax_rule_id
string
🇲🇽
Mexico
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽
Mexico
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. hsn_or_sac
string
🇮🇳
India
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
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.
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.
initial_stock
string
Opening stock of the item.
initial_stock_rate
string
Unit price of the opening stock.
item_tax_preferences
array
🇮🇳
India
only
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
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"}'
{
"name": "Hard Drive",
"rate": 120,
"description": "500GB",
"tax_id": 982000000037049,
"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",
"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": " ",
"initial_stock": " ",
"initial_stock_rate": " ",
"item_tax_preferences": [
{
"tax_id": 982000000037049,
"tax_specification": "intra"
}
]
}
{
"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"
}
],
"warehouses": [
{
"warehouse_id": "",
"warehouse_name": "",
"status": "active",
"is_primary": false,
"warehouse_stock_on_hand": "",
"warehouse_available_stock": "",
"warehouse_actual_available_stock": ""
}
]
}
}
List items
Get the list of all active items with pagination.
OAuth Scope : ZohoBooks.settings.READ
Query Parameters
name
Search items by name. Max-length [100]. Variants:
name_startswith and name_contains description
Search items by description. Max-length [100]. Variants:
description_startswith and description_contains rate
Search items by rate. Variants:
rate_less_than, rate_less_equals, rate_greater_than and rate_greater_equals tax_id
Search items by tax id.
tax_name
is_taxable
🇮🇳
India
,
🇺🇸
United States
,
🇲🇽
Mexico
only
Boolean to track the taxability of the item.
tax_exemption_id
🇮🇳
India
,
🇺🇸
United States
,
🇲🇽
Mexico
only
ID of the tax exemption. Mandatory, if
is_taxable is false. account_id
ID of the account to which the item has to be associated with.
filter_by
Filter items by status. Allowed Values:
Status.All, Status.Active and Status.Inactive search_text
Search items by name or description. Max-length [100]
sort_column
Sort items. Allowed Values:
name, rate and tax_name sat_item_key_code
🇲🇽
Mexico
only
SAT Item key code
unitkey_code
🇲🇽
Mexico
only
SAT Unit code
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
content-type: application/octet-stream
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'
{
"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"
},
{...},
{...}
],
"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
only
Id of the purchase tax rule
sales_tax_rule_id
string
🇲🇽
Mexico
only
Id of the sales tax rule
tax_percentage
string
Percent of the tax.
hsn_or_sac
string
🇮🇳
India
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. 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.
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.
initial_stock
string
Opening stock of the item.
initial_stock_rate
string
Unit price of the opening stock.
item_tax_preferences
array
🇮🇳
India
only
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
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"}'
{
"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",
"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": " ",
"initial_stock": " ",
"initial_stock_rate": " ",
"item_tax_preferences": [
{
"tax_id": 982000000037049,
"tax_specification": "intra"
}
]
}
{
"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"
}
],
"warehouses": [
{
"warehouse_id": "",
"warehouse_name": "",
"status": "active",
"is_primary": false,
"warehouse_stock_on_hand": "",
"warehouse_available_stock": "",
"warehouse_actual_available_stock": ""
}
]
}
}
Get an item
Details of an existing item.
OAuth Scope : ZohoBooks.settings.READ
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
content-type: application/octet-stream
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'
{
"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"
}
],
"warehouses": [
{
"warehouse_id": "",
"warehouse_name": "",
"status": "active",
"is_primary": false,
"warehouse_stock_on_hand": "",
"warehouse_available_stock": "",
"warehouse_actual_available_stock": ""
}
]
}
}
Delete an item
Delete the item created.items that are part of transaction cannot be deleted.
OAuth Scope : ZohoBooks.settings.DELETE
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
content-type: application/octet-stream
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'
{
"code": 0,
"message": "The item has been deleted."
}
Mark as active
Mark an inactive item as active.
OAuth Scope : ZohoBooks.settings.CREATE
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
content-type: application/octet-stream
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'
{
"code": 0,
"message": "The item has been marked as active."
}
Mark as inactive
Mark an active item as inactive.
OAuth Scope : ZohoBooks.settings.CREATE
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
content-type: application/octet-stream
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'
{
"code": 0,
"message": "The item has been marked as inactive."
}