Items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

🇮🇳 only

Tax preferences for the item.

Show Sub-Attributes

tax_id

string

🇮🇳 only

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

tax_specification

string

🇮🇳 only

Set whether the tax type is intra/interstate

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

locations

array

Locations for the item.

Show Sub-Attributes

location_id

string

Location ID. Note: This value is a set of numeric characters.

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.

{
    "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": "123456",
    "sat_item_key_code": "12345678",
    "unitkey_code": "12345678",
    "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 AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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 🇺🇸 , 🇮🇳

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

locations

array

Locations for the item.

Show Sub-Attributes

location_id

string

Location ID. Note: This value is a set of numeric characters.

initial_stock

string

Opening stock of the item.

initial_stock_rate

string

Unit price of the opening stock.

purchase_tax_rule_id

string

🇲🇽 , 🇰🇪 , 🇿🇦 only

Id of the purchase tax rule. Note: This value is a set of numeric characters.

sales_tax_rule_id

string

🇲🇽 , 🇰🇪 , 🇿🇦 only

Id of the sales tax rule. Note: This value is a set of numeric characters.

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

🇮🇳 , 🇰🇪 , 🇿🇦 only

HSN Code

sat_item_key_code

string

🇲🇽 only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 only

Add Unit Key Code for your goods/services. Download the CFDI Catalogs.

is_taxable

boolean

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

Boolean to track the taxability of the item.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

ID of the tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

purchase_tax_exemption_id

string

🇰🇪 , 🇿🇦 only

ID of the purchase tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

account_id

string

ID of the account to which the item has to be associated with. Note: This value is a set of numeric characters.

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. Note: This value is a set of numeric characters.

inventory_account_id

string

ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory. Note: This value is a set of numeric characters.

vendor_id

string

Preferred vendor ID. Note: This value is a set of numeric characters.

reorder_level

string

Reorder level of the item.

item_tax_preferences

array

🇮🇳 only

Tax preferences for the item.

Show Sub-Attributes

tax_id

string

🇮🇳 only

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

tax_specification

string

🇮🇳 only

Set whether the tax type is intra/interstate

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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,
    "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": "123456",
    "sat_item_key_code": "12345678",
    "unitkey_code": "12345678",
    "is_taxable": true,
    "tax_exemption_id": "123456789",
    "purchase_tax_exemption_id": "123456789",
    "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"
        }
    ]
}

{
    "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": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "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 AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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 🇺🇸 , 🇮🇳

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

purchase_tax_rule_id

string

🇲🇽 , 🇰🇪 , 🇿🇦 only

Id of the purchase tax rule. Note: This value is a set of numeric characters.

sales_tax_rule_id

string

🇲🇽 , 🇰🇪 , 🇿🇦 only

Id of the sales tax rule. Note: This value is a set of numeric characters.

tax_percentage

string

Percent of the tax.

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

HSN Code

sat_item_key_code

string

🇲🇽 only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 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

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

Boolean to track the taxability of the item.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

ID of the tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

purchase_tax_exemption_id

string

🇰🇪 , 🇿🇦 only

ID of the purchase tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

account_id

string

ID of the account to which the item has to be associated with. Note: This value is a set of numeric characters.

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. Note: This value is a set of numeric characters.

inventory_account_id

string

ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory. Note: This value is a set of numeric characters.

vendor_id

string

Preferred vendor ID. Note: This value is a set of numeric characters.

reorder_level

string

Reorder level of the item.

locations

array

Locations for the item.

Show Sub-Attributes

location_id

string

Location ID. Note: This value is a set of numeric characters.

initial_stock

string

Opening stock of the item.

initial_stock_rate

string

Unit price of the opening stock.

item_tax_preferences

array

🇮🇳 only

Tax preferences for the item.

Show Sub-Attributes

tax_id

string

🇮🇳 only

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

tax_specification

string

🇮🇳 only

Set whether the tax type is intra/interstate

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

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

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"}'

{
    "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": "123456",
    "sat_item_key_code": "12345678",
    "unitkey_code": "12345678",
    "sku": "s12345",
    "product_type": "goods",
    "is_taxable": true,
    "tax_exemption_id": "123456789",
    "purchase_tax_exemption_id": "123456789",
    "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"
        }
    ]
}

{
    "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": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "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 AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

name

string

Search items by name. Max-length [100]. Variants: name_startswith and name_contains

name_startswith

string

Search items whose name starts with the specified value. Maximum length allowed is 100 characters.

name_contains

string

Search items whose name contains the specified value. Maximum length allowed is 100 characters.

description

string

Search items by description. Max-length [100]. Variants: description_startswith and description_contains

description_startswith

string

Search items whose description starts with the specified value. Maximum length allowed is 100 characters.

description_contains

string

Search items whose description contains the specified value. Maximum length allowed is 100 characters.

rate

string

Search items by rate. Variants: rate_less_than, rate_less_equals, rate_greater_than and rate_greater_equals

rate_less_than

string

Search items whose rate is less than the specified value.

rate_less_equals

string

Search items whose rate is less than or equal to the specified value.

rate_greater_than

string

Search items whose rate is greater than the specified value.

rate_greater_equals

string

Search items whose rate is greater than or equal to the specified value.

tax_id

string

Search items by tax id. Note: This value is a set of numeric characters.

tax_name

string

Search items by tax name. Max-length [100]

is_taxable

boolean

🇮🇳 , 🇺🇸 , 🇲🇽 only

Boolean to track the taxability of the item.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇲🇽 only

ID of the tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

account_id

string

ID of the account to which the item has to be associated with. Note: This value is a set of numeric characters.

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

🇲🇽 only

SAT Item key code

unitkey_code

string

🇲🇽 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.

Request Example

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'

{
    "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": "12345678",
            "unitkey_code": "12345678",
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "value": "Normal"
                }
            ]
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 10,
        "has_more_page": false,
        "report_name": "Items",
        "sort_column": "name",
        "sort_order": "A"
    }
}

Bulk fetch item details AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Fetch item details for the mentioned item IDs
OAuth Scope : ZohoBooks.settings.READ

Query Parameters

item_ids

string

(Required)

List of item ids separated by comma. Note: This value is a set of numeric characters separated by comma.

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/itemdetails?item_ids=4815000000044208%2C4815000000044274%2C4815000000044340&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": "12345678",
            "unitkey_code": "12345678",
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "value": "Normal"
                }
            ]
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 10,
        "has_more_page": false,
        "report_name": "Items",
        "sort_column": "name",
        "sort_order": "A"
    }
}

Update an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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 🇺🇸 , 🇮🇳

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

purchase_tax_rule_id

string

🇲🇽 , 🇰🇪 , 🇿🇦 only

Id of the purchase tax rule. Note: This value is a set of numeric characters.

sales_tax_rule_id

string

🇲🇽 , 🇰🇪 , 🇿🇦 only

Id of the sales tax rule. Note: This value is a set of numeric characters.

tax_percentage

string

Percent of the tax.

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

HSN Code

sat_item_key_code

string

🇲🇽 only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 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

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

Boolean to track the taxability of the item.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

ID of the tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

purchase_tax_exemption_id

string

🇰🇪 , 🇿🇦 only

ID of the purchase tax exemption. Mandatory, if is_taxable is false. Note: This value is a set of numeric characters.

account_id

string

ID of the account to which the item has to be associated with. Note: This value is a set of numeric characters.

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. Note: This value is a set of numeric characters.

inventory_account_id

string

ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory. Note: This value is a set of numeric characters.

vendor_id

string

Preferred vendor ID. Note: This value is a set of numeric characters.

reorder_level

string

Reorder level of the item.

locations

array

Locations for the item.

Show Sub-Attributes

location_id

string

Location ID. Note: This value is a set of numeric characters.

initial_stock

string

Opening stock of the item.

initial_stock_rate

string

Unit price of the opening stock.

item_tax_preferences

array

🇮🇳 only

Tax preferences for the item.

Show Sub-Attributes

tax_id

string

🇮🇳 only

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

tax_specification

string

🇮🇳 only

Set whether the tax type is intra/interstate

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

Path Parameters

item_id

string

(Required)

Unique identifier of the item. Note: This value is a set of numeric characters.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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": "123456",
    "sat_item_key_code": "12345678",
    "unitkey_code": "12345678",
    "sku": "s12345",
    "product_type": "goods",
    "is_taxable": true,
    "tax_exemption_id": "123456789",
    "purchase_tax_exemption_id": "123456789",
    "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"
        }
    ]
}

{
    "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": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "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 AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

Path Parameters

item_id

string

(Required)

Unique identifier of the item. Note: This value is a set of numeric characters.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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'

{
    "code": 0,
    "message": "success",
    "item": {
        "item_id": 45667789900,
        "name": "Hard Drive",
        "status": "active",
        "description": "500GB",
        "rate": 120,
        "unit": "100GB",
        "hsn_or_sac": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "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 AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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. Note: This value is a set of numeric characters.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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'

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

Update custom field in existing items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

Arguments

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

Path Parameters

item_id

string

(Required)

Unique identifier of the item. Note: This value is a set of numeric characters.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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"}'

[
    {
        "customfield_id": "46000000012845",
        "value": "Normal"
    }
]

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

Mark as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

Path Parameters

item_id

string

(Required)

Unique identifier of the item. Note: This value is a set of numeric characters.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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'

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

Mark as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

Path Parameters

item_id

string

(Required)

Unique identifier of the item. Note: This value is a set of numeric characters.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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'

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

Create an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Creates a new item in Zoho Books. You can attach an image by passing the form-data parameter image.
OAuth Scope : ZohoBooks.items.CREATE

Arguments

item_master_name

string

(Required)

Name of the item.

name

string

Alternate name field accepted by some create payloads. Prefer item_master_name for item APIs.

brand

string

Brand of the item or variant.

manufacturer

string

Manufacturer of the item or variant.

unit

string

(Required)

If there is a measurement unit for the items you are adding.

description

string

Description for the item. Max-length [2000]

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

tax_id

string

Not applicable 🇺🇸 , 🇮🇳

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

is_taxable

boolean

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

Boolean to track the taxability of the item.

account_id

string

Sales account ID.

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. Note: This value is a set of numeric characters.

inventory_account_id

string

ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory. Note: This value is a set of numeric characters.

category_id

string

Category ID associated with the item.

attribute_name1

string

Name of the attribute present in the Item Group.

attribute_name2

string

Name of the second attribute.

attribute_name3

string

Name of the third attribute.

item_variants

array

(Required)

Variants to create under this item.

Show Sub-Attributes

variant_id

string

Unique ID generated by the server for the item variant. This is used as an identifier.

variant_name

string

(Required)

Name of the item variant.

rate

double

(Required)

Price of the item.

purchase_rate

string

Purchase price of the item.

sku

string

SKU value of item,should be unique throughout the product

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.

reorder_level

string

Reorder level of the item.

attribute_option_name1

string

Name of the attribute's option.

attribute_option_name2

string

Option name for the second attribute.

attribute_option_name3

string

Option name for the third attribute.

vendor_id

string

Preferred vendor ID. Note: This value is a set of numeric characters.

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

pricebook_id

string

Price book ID associated with the create request.

date

string

Date in yyyy-mm-dd format used for price computation.

document_ids

string

Comma-separated document IDs to associate with the item.

can_sync_to_variant

boolean

When true, sync applicable item fields to its variants.

Request Example

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/itemmasters?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/itemmasters?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/itemmasters?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/itemmasters?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/itemmasters?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/itemmasters?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "item_master_name": "Bags",
    "name": "string",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "100GB",
    "description": "500GB",
    "product_type": "goods",
    "tax_id": 982000000037049,
    "is_taxable": true,
    "account_id": "4815000000035001",
    "purchase_account_id": " ",
    "inventory_account_id": " ",
    "category_id": "4815000000044001",
    "attribute_name1": "Small",
    "attribute_name2": "string",
    "attribute_name3": "string",
    "item_variants": [
        {
            "variant_id": 4815000000044208,
            "variant_name": "Bags-small",
            "rate": 120,
            "purchase_rate": " ",
            "sku": "s12345",
            "upc": 111111111111,
            "ean": 111111111112,
            "isbn": 111111111113,
            "part_number": 111111111114,
            "reorder_level": " ",
            "attribute_option_name1": "Small",
            "attribute_option_name2": "string",
            "attribute_option_name3": "string",
            "vendor_id": " ",
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "value": "Normal"
                }
            ]
        }
    ],
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "The item has been added.",
    "item_master": {
        "item_master_id": 4815000000044220,
        "group_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_name": "Bags",
        "category_id": "4815000000044001",
        "category_name": "string",
        "product_type": "goods",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "unit": "100GB",
        "description": "500GB",
        "is_taxable": true,
        "tax_id": 982000000037049,
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "image_name": "bag_s.jpg",
        "image_type": "jpg",
        "documents": [
            "string"
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ],
        "item_variants": [
            {
                "variant_id": 4815000000044208,
                "variant_name": "Bags-small",
                "status": "active",
                "rate": 120,
                "purchase_rate": " ",
                "reorder_level": " ",
                "sku": "s12345",
                "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",
                "stock_on_hand": 50
            }
        ]
    }
}

List items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Lists all items in the organization. Supports filters, search, and pagination.
OAuth Scope : ZohoBooks.items.READ

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

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 25.

search_text

string

Search items by name or other searchable fields.

filter_by

string

Filter items by status. Allowed values: Status.All, Status.Active, Status.Inactive, Status.Ungrouped, Status.Grouped.

sort_column

string

Sort by column. Allowed values: group_name, created_time, last_modified_time, item_master_name.

sort_order

string

Sort order. Allowed values: A for ascending and D for descending.

item_master_name

string

Filter by exact item name.

item_master_name_startswith

string

Filter by item name that starts with the given value.

item_master_name_contains

string

Filter by item name that contains the given value.

description

string

Filter by exact description.

rate

double

Filter by exact selling rate.

purchase_rate

double

Filter by exact purchase rate.

brand

string

Filter by brand.

manufacturer

string

Filter by manufacturer.

category_id

string

Filter by category ID.

account_id

string

Filter by sales account ID.

purchase_account_id

string

Filter by purchase account ID.

inventory_account_id

string

Filter by inventory account ID.

tax_id

string

Filter by tax ID.

skip_variant

boolean

When true, omit nested variant details from the list response.

last_modified_time

string

Return items modified on or after this UTC datetime.

Request Example

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

{
    "code": 0,
    "message": "success",
    "item_masters": [
        {
            "item_master_id": 4815000000044220,
            "group_id": 4815000000044220,
            "item_master_name": "Bags",
            "group_name": "Bags",
            "category_id": "4815000000044001",
            "category_name": "string",
            "product_type": "goods",
            "brand": "Brand",
            "manufacturer": "Bagstore",
            "unit": "100GB",
            "description": "500GB",
            "is_taxable": true,
            "tax_id": 982000000037049,
            "tax_name": "Sales Tax",
            "tax_percentage": "70%",
            "tax_type": "tax",
            "purchase_account_id": " ",
            "purchase_account_name": "Cost of Goods Sold",
            "account_name": "Sales",
            "inventory_account_id": " ",
            "attribute_id1": 4815000000044112,
            "attribute_name1": "Small",
            "status": "active",
            "source": "string",
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "documents": [
                "string"
            ],
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "value": "Normal"
                }
            ],
            "item_variants": [
                {
                    "variant_id": 4815000000044208,
                    "variant_name": "Bags-small",
                    "status": "active",
                    "rate": 120,
                    "purchase_rate": " ",
                    "reorder_level": " ",
                    "sku": "s12345",
                    "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",
                    "stock_on_hand": 50
                }
            ]
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 25,
        "has_more_page": true,
        "report_name": "string",
        "applied_filter": "string",
        "sort_column": "string",
        "sort_order": "string"
    }
}

Update an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Updates the details of an existing item. You can attach or replace an image by passing the form-data parameter image.
OAuth Scope : ZohoBooks.items.UPDATE

Path Parameters

item_master_id

string

(Required)

Unique identifier of the item.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

update_recurring_invoice

boolean

When true, apply rate changes to associated recurring invoices.

pricebook_id

string

Price book ID associated with the update request.

date

string

Date in yyyy-mm-dd format used for price computation.

delete_image

boolean

When true, deletes the existing item image.

can_sync_to_variant

boolean

When true, sync applicable item fields to its variants.

Request Example

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/itemmasters/4815000000044220?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/itemmasters/4815000000044220?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/itemmasters/4815000000044220?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/itemmasters/4815000000044220?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/itemmasters/4815000000044220?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/itemmasters/4815000000044220?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "item_master_name": "Bags",
    "name": "string",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "100GB",
    "description": "500GB",
    "product_type": "goods",
    "tax_id": 982000000037049,
    "is_taxable": true,
    "account_id": "4815000000035001",
    "purchase_account_id": " ",
    "inventory_account_id": " ",
    "category_id": "4815000000044001",
    "attribute_name1": "Small",
    "attribute_name2": "string",
    "attribute_name3": "string",
    "item_variants": [
        {
            "variant_id": 4815000000044208,
            "variant_name": "Bags-small",
            "rate": 120,
            "purchase_rate": " ",
            "sku": "s12345",
            "upc": 111111111111,
            "ean": 111111111112,
            "isbn": 111111111113,
            "part_number": 111111111114,
            "reorder_level": " ",
            "attribute_option_name1": "Small",
            "attribute_option_name2": "string",
            "attribute_option_name3": "string",
            "vendor_id": " ",
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "value": "Normal"
                }
            ]
        }
    ],
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "Item details have been updated.",
    "item_master": {
        "item_master_id": 4815000000044220,
        "group_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_name": "Bags",
        "category_id": "4815000000044001",
        "category_name": "string",
        "product_type": "goods",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "unit": "100GB",
        "description": "500GB",
        "is_taxable": true,
        "tax_id": 982000000037049,
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "image_name": "bag_s.jpg",
        "image_type": "jpg",
        "documents": [
            "string"
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ],
        "item_variants": [
            {
                "variant_id": 4815000000044208,
                "variant_name": "Bags-small",
                "status": "active",
                "rate": 120,
                "purchase_rate": " ",
                "reorder_level": " ",
                "sku": "s12345",
                "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",
                "stock_on_hand": 50
            }
        ]
    }
}

Retrieve an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Fetches the details of an existing item.
OAuth Scope : ZohoBooks.items.READ

Path Parameters

item_master_id

string

(Required)

Unique identifier of the item.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

include

string

Additional response content. Allowed value: html.

string

Print-related flag. Allowed values follow the boolean-all convention.

Request Example

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

{
    "code": 0,
    "message": "success",
    "item_master": {
        "item_master_id": 4815000000044220,
        "group_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_name": "Bags",
        "category_id": "4815000000044001",
        "category_name": "string",
        "product_type": "goods",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "unit": "100GB",
        "description": "500GB",
        "is_taxable": true,
        "tax_id": 982000000037049,
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "image_name": "bag_s.jpg",
        "image_type": "jpg",
        "documents": [
            "string"
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ],
        "item_variants": [
            {
                "variant_id": 4815000000044208,
                "variant_name": "Bags-small",
                "status": "active",
                "rate": 120,
                "purchase_rate": " ",
                "reorder_level": " ",
                "sku": "s12345",
                "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",
                "stock_on_hand": 50
            }
        ]
    }
}

Delete an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Deletes an existing item.
OAuth Scope : ZohoBooks.items.DELETE

Path Parameters

item_master_id

string

(Required)

Unique identifier of the item.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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

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

Bulk mark items as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of multiple items to active.
OAuth Scope : ZohoBooks.items.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

item_master_ids

string

(Required)

Comma-separated list of item IDs.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/itemmasters/active?organization_id=10234695&item_master_ids=4815000000044220,4815000000044221"
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/itemmasters/active?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221")
  .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/itemmasters/active?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221', 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/itemmasters/active?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221", 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/itemmasters/active?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221",
  "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/itemmasters/active?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Bulk mark items as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of multiple items to inactive.
OAuth Scope : ZohoBooks.items.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

item_master_ids

string

(Required)

Comma-separated list of item IDs.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/itemmasters/inactive?organization_id=10234695&item_master_ids=4815000000044220,4815000000044221"
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/itemmasters/inactive?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221")
  .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/itemmasters/inactive?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221', 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/itemmasters/inactive?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221", 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/itemmasters/inactive?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221",
  "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/itemmasters/inactive?organization_id=10234695&item_master_ids=4815000000044220%2C4815000000044221' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Mark an item as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

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

Path Parameters

item_master_id

string

(Required)

Unique identifier of the item.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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

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

Mark an item as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of an item to inactive.
OAuth Scope : ZohoBooks.items.CREATE

Path Parameters

item_master_id

string

(Required)

Unique identifier of the item.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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

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

Create an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Creates a new item variant in Zoho Books. You can attach an image by passing the form-data parameter image.
OAuth Scope : ZohoBooks.settings.CREATE

Arguments

variant_id

string

Unique ID generated by the server for the item variant. This is used as an identifier.

variant_name

string

(Required)

Name of the item variant.

rate

double

(Required)

Price of the item.

group_id

string

Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier.

item_master_id

string

Unique ID generated by the server for the item. This is used as an identifier.

unit

string

If there is a measurement unit for the items you are adding.

unit_id

string

Unique ID of the unit associated with the item.

item_type

string

Type of the item. Allowed values: sales,purchases,sales_and_purchases and inventory. Default value will be sales.

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

can_be_sold

boolean

Boolean to indicate whether the item can be sold.

can_be_purchased

boolean

Boolean to indicate whether the item can be purchased.

track_inventory

boolean

Boolean to indicate whether inventory tracking is enabled for the item.

is_taxable

boolean

🇮🇳 , 🇺🇸 , 🇲🇽 , 🇰🇪 , 🇿🇦 only

Boolean to track the taxability of the item.

tax_id

string

Not applicable 🇺🇸 , 🇮🇳

ID of the tax to be associated to the item. Note: This value is a set of numeric characters.

description

string

Description for the item. Max-length [2000]

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. Note: This value is a set of numeric characters.

inventory_account_id

string

ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory. Note: This value is a set of numeric characters.

reorder_level

string

Reorder level of the item.

sku

string

SKU value of item,should be unique throughout the product

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

string

Name of the attribute's option.

vendor_id

string

Preferred vendor ID. Note: This value is a set of numeric characters.

brand

string

Brand of the item or variant.

manufacturer

string

Manufacturer of the item or variant.

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

HSN Code

locations

array

List of locations.

Show Sub-Attributes

location_id

string

Location ID. Note: This value is a set of numeric characters.

initial_stock

string

Opening stock of the item.

initial_stock_rate

string

Unit price of the opening stock.

custom_fields

array

Custom fields for an item.

Show Sub-Attributes

customfield_id

string

ID of the custom field. Note: This value is a set of numeric characters.

value

string

Value of the Custom Field

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

pricebook_id

string

Price book ID associated with the create request.

date

string

Date in yyyy-mm-dd format used for price computation.

Request Example

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/itemvariants?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/itemvariants?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/itemvariants?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/itemvariants?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/itemvariants?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/itemvariants?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "variant_id": 4815000000044208,
    "variant_name": "Bags-small",
    "rate": 120,
    "group_id": 4815000000044220,
    "item_master_id": 4815000000044220,
    "unit": "100GB",
    "unit_id": "4815000000044300",
    "item_type": " ",
    "product_type": "goods",
    "can_be_sold": true,
    "can_be_purchased": true,
    "track_inventory": true,
    "is_taxable": true,
    "tax_id": 982000000037049,
    "description": "500GB",
    "purchase_description": " ",
    "purchase_rate": " ",
    "purchase_account_id": " ",
    "inventory_account_id": " ",
    "reorder_level": " ",
    "sku": "s12345",
    "upc": 111111111111,
    "ean": 111111111112,
    "isbn": 111111111113,
    "part_number": 111111111114,
    "attribute_option_name1": "Small",
    "vendor_id": " ",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "hsn_or_sac": "123456",
    "locations": [
        {
            "location_id": "460000000038080",
            "initial_stock": " ",
            "initial_stock_rate": " "
        }
    ],
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "The item has been added.",
    "item_variant": {
        "variant_id": 4815000000044208,
        "variant_name": "Bags-small",
        "item_master_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "unit": "100GB",
        "unit_id": "4815000000044300",
        "item_type": " ",
        "product_type": "goods",
        "can_be_sold": true,
        "can_be_purchased": true,
        "track_inventory": true,
        "is_taxable": true,
        "tax_id": 982000000037049,
        "documents": [
            "string"
        ],
        "description": "500GB",
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "rate": 120,
        "pricebook_rate": 6,
        "purchase_rate": " ",
        "reorder_level": " ",
        "vendor_id": " ",
        "vendor_name": "Molly",
        "locations": [
            {
                "location_id": "460000000038080",
                "location_name": "",
                "status": "active",
                "is_primary": false,
                "location_stock_on_hand": "",
                "location_available_stock": "",
                "location_actual_available_stock": ""
            }
        ],
        "sku": "s12345",
        "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": " ",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 982000000037049,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "is_combo_product": false,
        "stock_on_hand": 50,
        "created_time": "2013-01-24",
        "last_modified_time": "2013-01-24",
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ]
    }
}

List item variants AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Lists all item variants in the organization. Supports filters, search, and pagination.
OAuth Scope : ZohoBooks.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

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.

search_text

string

Search variants by name, SKU, or other searchable fields.

filter_by

string

Filter variants by status or item type. Allowed values include Status.All, Status.Active, Status.Inactive, Status.Lowstock, Status.Unmapped, Status.Uncategorized, Status.Grouped, and item-type filters from the Items list API.

sort_column

string

Sort by column. Allowed values include name, sku, rate, purchase_rate, created_time, last_modified_time, reorder_level, and stock_on_hand.

sort_order

string

Sort order. Allowed values: A for ascending and D for descending.

status

string

Filter by variant status. Allowed values: active, inactive, confirmation_pending.

name

string

Filter by exact variant name.

name_startswith

string

Filter by variant name that starts with the given value.

name_contains

string

Filter by variant name that contains the given value.

sku

string

Filter by exact SKU.

sku_startswith

string

Filter by SKU that starts with the given value.

sku_contains

string

Filter by SKU that contains the given value.

rate

double

Filter by exact selling rate.

purchase_rate

double

Filter by exact purchase rate.

item_master_id

string

Filter variants belonging to the given item.

variant_ids

string

Comma-separated list of variant IDs to fetch.

brand

string

Filter by brand.

manufacturer

string

Filter by manufacturer.

category_id

string

Filter by category ID.

warehouse_id

string

Filter by warehouse ID.

location_id

string

Filter by location ID.

product_type

string

Filter by product type.

is_combo_product

boolean

Filter by whether the variant is a combo product.

last_modified_time

string

Return variants modified on or after this UTC datetime.

Request Example

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

{
    "code": 0,
    "message": "success",
    "item_variants": [
        {
            "variant_id": 4815000000044208,
            "variant_name": "Bags-small",
            "item_master_id": 4815000000044220,
            "item_master_name": "Bags",
            "group_id": 4815000000044220,
            "group_name": "Bags",
            "unit": "100GB",
            "unit_id": "4815000000044300",
            "item_type": " ",
            "product_type": "goods",
            "can_be_sold": true,
            "can_be_purchased": true,
            "track_inventory": true,
            "is_taxable": true,
            "tax_id": 982000000037049,
            "documents": [
                "string"
            ],
            "description": "500GB",
            "tax_name": "Sales Tax",
            "tax_percentage": "70%",
            "tax_type": "tax",
            "purchase_account_id": " ",
            "purchase_account_name": "Cost of Goods Sold",
            "account_name": "Sales",
            "inventory_account_id": " ",
            "attribute_id1": 4815000000044112,
            "attribute_name1": "Small",
            "status": "active",
            "source": "string",
            "rate": 120,
            "pricebook_rate": 6,
            "purchase_rate": " ",
            "reorder_level": " ",
            "vendor_id": " ",
            "vendor_name": "Molly",
            "locations": [
                {
                    "location_id": "460000000038080",
                    "location_name": "",
                    "status": "active",
                    "is_primary": false,
                    "location_stock_on_hand": "",
                    "location_available_stock": "",
                    "location_actual_available_stock": ""
                }
            ],
            "sku": "s12345",
            "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": " ",
            "image_type": "jpg",
            "item_tax_preferences": [
                {
                    "tax_id": 982000000037049,
                    "tax_specification": "intra"
                }
            ],
            "hsn_or_sac": "123456",
            "sat_item_key_code": "12345678",
            "unitkey_code": "12345678",
            "brand": "Brand",
            "manufacturer": "Bagstore",
            "is_combo_product": false,
            "stock_on_hand": 50,
            "created_time": "2013-01-24",
            "last_modified_time": "2013-01-24",
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "value": "Normal"
                }
            ]
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 25,
        "has_more_page": true,
        "report_name": "string",
        "applied_filter": "string",
        "sort_column": "string",
        "sort_order": "string"
    }
}

Bulk delete item variants AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Deletes multiple item variants.
OAuth Scope : ZohoBooks.items.DELETE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

variant_ids

string

Comma-separated list of variant IDs to delete.

Request Example

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

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

Update an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Updates the details of an existing item variant. You can attach or replace an image by passing the form-data parameter image.
OAuth Scope : ZohoBooks.items.UPDATE

Path Parameters

variant_id

string

(Required)

Unique identifier of the item variant.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

update_recurring_invoice

boolean

When true, apply rate changes to associated recurring invoices.

pricebook_id

string

Price book ID associated with the update request.

date

string

Date in yyyy-mm-dd format used for price computation.

delete_image

boolean

When true, deletes the existing variant image.

can_sync_to_master

boolean

When true, sync applicable variant fields to the parent item.

Request Example

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/itemvariants/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/books/v3/itemvariants/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/books/v3/itemvariants/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", "/books/v3/itemvariants/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": "/books/v3/itemvariants/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/books/v3/itemvariants/4815000000044208?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "variant_id": 4815000000044208,
    "variant_name": "Bags-small",
    "rate": 120,
    "group_id": 4815000000044220,
    "item_master_id": 4815000000044220,
    "unit": "100GB",
    "unit_id": "4815000000044300",
    "item_type": " ",
    "product_type": "goods",
    "can_be_sold": true,
    "can_be_purchased": true,
    "track_inventory": true,
    "is_taxable": true,
    "tax_id": 982000000037049,
    "description": "500GB",
    "purchase_description": " ",
    "purchase_rate": " ",
    "purchase_account_id": " ",
    "inventory_account_id": " ",
    "reorder_level": " ",
    "sku": "s12345",
    "upc": 111111111111,
    "ean": 111111111112,
    "isbn": 111111111113,
    "part_number": 111111111114,
    "attribute_option_name1": "Small",
    "vendor_id": " ",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "hsn_or_sac": "123456",
    "locations": [
        {
            "location_id": "460000000038080",
            "initial_stock": " ",
            "initial_stock_rate": " "
        }
    ],
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "Item details have been updated",
    "item_variant": {
        "variant_id": 4815000000044208,
        "variant_name": "Bags-small",
        "item_master_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "unit": "100GB",
        "unit_id": "4815000000044300",
        "item_type": " ",
        "product_type": "goods",
        "can_be_sold": true,
        "can_be_purchased": true,
        "track_inventory": true,
        "is_taxable": true,
        "tax_id": 982000000037049,
        "documents": [
            "string"
        ],
        "description": "500GB",
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "rate": 120,
        "pricebook_rate": 6,
        "purchase_rate": " ",
        "reorder_level": " ",
        "vendor_id": " ",
        "vendor_name": "Molly",
        "locations": [
            {
                "location_id": "460000000038080",
                "location_name": "",
                "status": "active",
                "is_primary": false,
                "location_stock_on_hand": "",
                "location_available_stock": "",
                "location_actual_available_stock": ""
            }
        ],
        "sku": "s12345",
        "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": " ",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 982000000037049,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "is_combo_product": false,
        "stock_on_hand": 50,
        "created_time": "2013-01-24",
        "last_modified_time": "2013-01-24",
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ]
    }
}

Retrieve an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Fetches the details of an existing item variant.
OAuth Scope : ZohoBooks.settings.READ

Path Parameters

variant_id

string

(Required)

Unique identifier of the item variant.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

pricebook_id

string

Price book ID used to compute the price book rate.

contact_id

string

Contact ID used for tax or price computation.

location_id

string

Location ID for stock and pricing context.

branch_id

string

Branch ID for stock and pricing context.

date

string

Transaction date in yyyy-mm-dd format used for price and tax computation.

include

string

Additional response content. Allowed value: html.

Request Example

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

{
    "code": 0,
    "message": "success",
    "item_variant": {
        "variant_id": 4815000000044208,
        "variant_name": "Bags-small",
        "item_master_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "unit": "100GB",
        "unit_id": "4815000000044300",
        "item_type": " ",
        "product_type": "goods",
        "can_be_sold": true,
        "can_be_purchased": true,
        "track_inventory": true,
        "is_taxable": true,
        "tax_id": 982000000037049,
        "documents": [
            "string"
        ],
        "description": "500GB",
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "rate": 120,
        "pricebook_rate": 6,
        "purchase_rate": " ",
        "reorder_level": " ",
        "vendor_id": " ",
        "vendor_name": "Molly",
        "locations": [
            {
                "location_id": "460000000038080",
                "location_name": "",
                "status": "active",
                "is_primary": false,
                "location_stock_on_hand": "",
                "location_available_stock": "",
                "location_actual_available_stock": ""
            }
        ],
        "sku": "s12345",
        "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": " ",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 982000000037049,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "is_combo_product": false,
        "stock_on_hand": 50,
        "created_time": "2013-01-24",
        "last_modified_time": "2013-01-24",
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ]
    }
}

Delete an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Deletes an existing item variant.
OAuth Scope : ZohoBooks.settings.DELETE

Path Parameters

variant_id

string

(Required)

Unique identifier of the item variant.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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

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

Bulk mark item variants as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of multiple item variants to active.
OAuth Scope : ZohoBooks.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

variant_ids

string

(Required)

Comma-separated list of variant IDs.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/itemvariants/active?organization_id=10234695&variant_ids=4815000000044208,4815000000044274"
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/itemvariants/active?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274")
  .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/itemvariants/active?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274', 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/itemvariants/active?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274", 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/itemvariants/active?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274",
  "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/itemvariants/active?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Bulk mark item variants as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of multiple item variants to inactive.
OAuth Scope : ZohoBooks.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

variant_ids

string

(Required)

Comma-separated list of variant IDs.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/itemvariants/inactive?organization_id=10234695&variant_ids=4815000000044208,4815000000044274"
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/itemvariants/inactive?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274")
  .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/itemvariants/inactive?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274', 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/itemvariants/inactive?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274", 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/itemvariants/inactive?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274",
  "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/itemvariants/inactive?organization_id=10234695&variant_ids=4815000000044208%2C4815000000044274' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Mark an item variant as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of an item variant to active.
OAuth Scope : ZohoBooks.settings.CREATE

Path Parameters

variant_id

string

(Required)

Unique identifier of the item variant.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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

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

Mark an item variant as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Changes the status of an item variant to inactive.
OAuth Scope : ZohoBooks.settings.CREATE

Path Parameters

variant_id

string

(Required)

Unique identifier of the item variant.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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

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

Move an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Moves an item variant to another item. The request body follows the item variant create or update structure and must include the target grouping fields.
OAuth Scope : ZohoBooks.items.UPDATE

Path Parameters

variant_id

string

(Required)

Unique identifier of the item variant to move.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

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/itemvariants/move/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/books/v3/itemvariants/move/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/books/v3/itemvariants/move/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", "/books/v3/itemvariants/move/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": "/books/v3/itemvariants/move/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/books/v3/itemvariants/move/4815000000044208?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "variant_id": 4815000000044208,
    "variant_name": "Bags-small",
    "rate": 120,
    "group_id": 4815000000044220,
    "item_master_id": 4815000000044220,
    "unit": "100GB",
    "unit_id": "4815000000044300",
    "item_type": " ",
    "product_type": "goods",
    "can_be_sold": true,
    "can_be_purchased": true,
    "track_inventory": true,
    "is_taxable": true,
    "tax_id": 982000000037049,
    "description": "500GB",
    "purchase_description": " ",
    "purchase_rate": " ",
    "purchase_account_id": " ",
    "inventory_account_id": " ",
    "reorder_level": " ",
    "sku": "s12345",
    "upc": 111111111111,
    "ean": 111111111112,
    "isbn": 111111111113,
    "part_number": 111111111114,
    "attribute_option_name1": "Small",
    "vendor_id": " ",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "hsn_or_sac": "123456",
    "locations": [
        {
            "location_id": "460000000038080",
            "initial_stock": " ",
            "initial_stock_rate": " "
        }
    ],
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Normal"
        }
    ]
}

{
    "code": 0,
    "message": "success",
    "item_variant": {
        "variant_id": 4815000000044208,
        "variant_name": "Bags-small",
        "item_master_id": 4815000000044220,
        "item_master_name": "Bags",
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "unit": "100GB",
        "unit_id": "4815000000044300",
        "item_type": " ",
        "product_type": "goods",
        "can_be_sold": true,
        "can_be_purchased": true,
        "track_inventory": true,
        "is_taxable": true,
        "tax_id": 982000000037049,
        "documents": [
            "string"
        ],
        "description": "500GB",
        "tax_name": "Sales Tax",
        "tax_percentage": "70%",
        "tax_type": "tax",
        "purchase_account_id": " ",
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": " ",
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "source": "string",
        "rate": 120,
        "pricebook_rate": 6,
        "purchase_rate": " ",
        "reorder_level": " ",
        "vendor_id": " ",
        "vendor_name": "Molly",
        "locations": [
            {
                "location_id": "460000000038080",
                "location_name": "",
                "status": "active",
                "is_primary": false,
                "location_stock_on_hand": "",
                "location_available_stock": "",
                "location_actual_available_stock": ""
            }
        ],
        "sku": "s12345",
        "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": " ",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 982000000037049,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": "123456",
        "sat_item_key_code": "12345678",
        "unitkey_code": "12345678",
        "brand": "Brand",
        "manufacturer": "Bagstore",
        "is_combo_product": false,
        "stock_on_hand": 50,
        "created_time": "2013-01-24",
        "last_modified_time": "2013-01-24",
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Normal"
            }
        ]
    }
}

Mark item variants as single items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Marks the specified item variants as single items.
OAuth Scope : ZohoBooks.items.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

variant_ids

string

Comma-separated list of variant IDs to ungroup.

composite_item_ids

string

Comma-separated list of composite item IDs to ungroup.

Request Example

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

{
    "code": 0,
    "message": "The selected variants have been ungrouped."
}

Items AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Attribute

Create an Item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

Arguments

Query Parameters

Headers

List items AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Bulk fetch item details AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Update an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Query Parameters

Get an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Delete an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Arguments

Path Parameters

Query Parameters

Mark as active AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Mark as inactive AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Create an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

List items AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Update an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Retrieve an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Delete an item AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Bulk mark items as active AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Bulk mark items as inactive AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Mark an item as active AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Mark an item as inactive AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Create an item variant AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

List item variants AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Bulk delete item variants AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Update an item variant AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Retrieve an item variant AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Delete an item variant AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Bulk mark item variants as active AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Bulk mark item variants as inactive AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Mark an item variant as active AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Mark an item variant as inactive AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create an Item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Bulk fetch item details AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Mark as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Mark as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List items AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete an item AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Bulk mark items as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Bulk mark items as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Mark an item as active AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Mark an item as inactive AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Create an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List item variants AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Bulk delete item variants AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Move an item variant AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab