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

Composite Items

A form or version of an composite item that differs in some respect from other forms of the same or from a standard. You can create your composite items by associating multiple items and their respective quantities.

Download Composite Items OpenAPI Document
Download
Download Zoho Inventory OpenAPI Document
End Points
Creating a Composite Item
List All Composite Items
Updating a composite item
Retrieving a Composite Item
Deleting a Composite Item
Mark as Active
Mark as Inactive
Create Assemblies
Assemblies History
Retrieve Assemblies
Delete Assemblies

Attribute

composite_item_id
long
Unique ID generated for the composite item by the server. This is used as identifier
name
string
Name of the composite item
unit
string
Unit of Item
tax_id
long
Unique ID generated by the server for the tax .
description
string
Sample Description.
tax_name
string
Name of the tax applied on selling this item
tax_percentage
double
Percentage at which the item is taxed
tax_type
string
Type of tax. It can either Tax or Group Tax
purchase_account_id
long
Unique ID generated by the server for the type of purchase
purchase_account_name
string
Type of purchase under which the composite item was bought
account_id
long
Unique ID generated by the server for the type of sale of this item
account_name
string
Type of sale under which the composite item is sold
inventory_account_id
long
Unique ID generated by the server for the type of inventory for this item
inventory_account_name
string
Name of inventory type
status
string
Status of the Item
source
string
source
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
item_type
string
Type of item Always inventory
rate
double
Selling price of the item
pricebook_rate
double
Price list applied on the item's selling price.
purchase_rate
double
Buying price of the item
reorder_level
double
Reorder point of the item
initial_stock
double
Initial stock of item
initial_stock_rate
double
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
vendor_id
long
Unique ID generated by the server for preferred vendor to buy this composite item
vendor_name
string
Name of the preferred vendor
stock_on_hand
double
Stock based on Invoices and Bills
asset_value
double
value of the composite items based on purchase rate
available_stock
double
Stock based on Shipments and Receives
actual_available_stock
double
Stock based on Shipments and Receives minus ordered stock
sku
string
Stock Keeping Unit value of the item. It should be unique throughout the product
upc
long
Unique Product Code, 12 digit unique code of the item
ean
long
European Article Number, 13 digit barcode number of the item
isbn
long
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
part_number
string
MPN - Manufacturing Part Number, unambiguously identifies a part design
image_id
long
Unique identifier generated by the server for item image
image_name
string
Name of the image
purchase_description
string
Purchase description of the item
custom_fields
array
Custom fields are used to add more information about the item
Show Sub-Attributes arrow
custom_field_id
long
Unique ID generated by the server for the custom field.
value
string
Value of the custom field.
index
integer
Index of the custom field. It can hold any value from 1 to 10.
label
string
Label of the custom field.
mapped_items
array
Items that are associated with the composite item
Show Sub-Attributes arrow
line_item_id
long
Unique ID generated by the server for mapping the associated item with composite item
item_id
long
Unique ID generated by the server for the Item. This is used as an identifier.
name
string
Name of the composite item
rate
double
Selling price of the item
purchase_rate
double
Buying price of the item
sku
string
Stock Keeping Unit value of the item. It should be unique throughout the product
image_id
long
Unique identifier generated by the server for item image
image_name
string
Name of the image
purchase_description
string
Purchase description of the item
image_type
string
Type of the image Only images with gif,png,jpeg,jpg,bmp extensions are allowed
unit
string
Unit of Item
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
description
string
Sample Description.
quantity
double
Quantity of item associated with the composite item
stock_on_hand
double
Stock based on Invoices and Bills
available_stock
double
Stock based on Shipments and Receives
actual_available_stock
double
Stock based on Shipments and Receives minus ordered stock
item_tax_preferences
array
🇮🇳 India
only
List of tax preferences of the item
Show Sub-Attributes arrow
tax_id
long
Unique ID generated by the server for the tax .
tax_specification
string
🇮🇳 India
only
Type of tax. It can be intra or inter
hsn_or_sac
string
🇮🇳 India
only
HSN Code of the item

Example

{ "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Just a sample description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "asset_value": 0.1, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 4815000000044208, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Just a sample description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ], "item_tax_preferences": [ { "tax_id": 504366000000053100, "tax_specification": "intra" } ], "hsn_or_sac": 85423100 }

Creating a Composite Item

A new composite item can be created after creating items that we want to associcate with composite item. User can attach image for composite item by calling Different API 'https://www.zohoapis.com/inventory/v1/compositeitems/{composite_item_id}/image', passing form-data parameter image i.e. -F image=bag_s.jpg
OAuth Scope : ZohoInventory.compositeitems.CREATE

Arguments

name
string
(Required)
Name of the composite item
mapped_items
array
(Required)
Items that are associated with the composite item
Show Sub-Attributes arrow
quantity
double
Quantity of item associated with the composite item
item_id
long
(Required)
Unique ID generated by the server for the Item. This is used as an identifier.
line_item_id
long
Unique ID generated by the server for mapping the associated item with composite item
description
string
Sample Description.
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
vendor_id
long
Unique ID generated by the server for preferred vendor to buy this composite item
purchase_rate
double
Buying price of the item
purchase_description
string
Purchase description of the item
initial_stock
double
Initial stock of item
initial_stock_rate
double
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
tax_id
long
Unique ID generated by the server for the tax .
sku
string
(Required)
Stock Keeping Unit value of the item. It should be unique throughout the product
isbn
long
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
ean
long
European Article Number, 13 digit barcode number of the item
part_number
string
MPN - Manufacturing Part Number, unambiguously identifies a part design
reorder_level
double
Reorder point of the item
unit
string
Unit of Item
upc
long
Unique Product Code, 12 digit unique code of the item
item_type
string
(Required)
Type of item Always inventory
rate
double
(Required)
Selling price of the item
custom_fields
array
Custom fields are used to add more information about the item
Show Sub-Attributes arrow
custom_field_id
long
Unique ID generated by the server for the custom field.
value
string
Value of the custom field.
account_id
long
Unique ID generated by the server for the type of sale of this item
purchase_account_id
long
Unique ID generated by the server for the type of purchase
inventory_account_id
long
Unique ID generated by the server for the type of inventory for this item
item_tax_preferences
array
🇮🇳 India
only
List of tax preferences of the item
Show Sub-Attributes arrow
tax_id
long
Unique ID generated by the server for the tax .
tax_specification
string
🇮🇳 India
only
Type of tax. It can be intra or inter
hsn_or_sac
string
🇮🇳 India
only
HSN Code of the item
product_type
string
(Required)
Type of the product.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

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

Body Parameters

Click to copy
{ "name": "Combo of Apple IPhone and Smartwatch", "mapped_items": [ { "quantity": 1, "item_id": 4815000000044208, "line_item_id": 504366000000053250 } ], "description": "Just a sample description", "is_combo_product": true, "vendor_id": 504366000000053250, "purchase_rate": 30000, "purchase_description": "Composite item purchase description", "initial_stock": 2, "initial_stock_rate": 30000, "tax_id": 504366000000053100, "sku": "SKUIS", "isbn": 368302334, "ean": 5789414385764, "part_number": "JHFKE7GK7", "reorder_level": 1, "unit": "units", "upc": 746325287436, "item_type": "inventory", "rate": 85000, "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078" } ], "account_id": 504366000000000400, "purchase_account_id": 504366000000034000, "inventory_account_id": 504366000000034000, "item_tax_preferences": [ { "tax_id": 504366000000053100, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "product_type": "goods" }

Response Example

{ "code": 0, "message": "The item has been added.", "composite_item": { "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Just a sample description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "asset_value": 0.1, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 4815000000044208, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Just a sample description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ], "item_tax_preferences": [ { "tax_id": 504366000000053100, "tax_specification": "intra" } ], "hsn_or_sac": 85423100 } }

List All Composite Items

List of all composite items.
OAuth Scope : ZohoInventory.compositeitems.READ

Query Parameters

organization_id
string
(Required)
ID of the organization
page
integer
Page Number
per_page
integer
Items to be displayed per page
sort_column
string
column to be used for sorting. Allowed values: name,sku,rate,tax_name,purchase_rate,created_time,last_modified_time,reorder_level
sort_order
string
order used for sorting
filter_by
string
Filter items by status. Allowed values: Status.All,Status.Active,Inactive,Lowstock
usestate
boolean
Whether current filter needs to be saved
response_option
integer
response format number

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/compositeitems?organization_id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/compositeitems?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/compositeitems?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/compositeitems?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/compositeitems?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.com/inventory/v1/compositeitems?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "composite_items": [ { "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "status": "active", "source": "user", "description": "Just a sample description", "rate": 85000, "tax_id": 504366000000053100, "tax_name": "VAT", "tax_percentage": 13, "purchase_description": "Composite item purchase description", "purchase_rate": 30000, "is_combo_product": true, "item_type": "inventory", "product_type": "goods", "is_taxable": true, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "reorder_level": 1, "image_id": 8408722000000019000, "image_name": "img1.jpg", "created_time": "2013-08-05", "last_modified_time": "string" }, {...}, {...} ] }

Updating a composite item

Updating details of an existing composite item.
OAuth Scope : ZohoInventory.compositeitems.UPDATE

Arguments

composite_item_id
long
Unique ID generated for the composite item by the server. This is used as identifier
name
string
(Required)
Name of the composite item
unit
string
Unit of Item
tax_id
long
Unique ID generated by the server for the tax .
description
string
Sample Description.
tax_name
string
Name of the tax applied on selling this item
tax_percentage
double
Percentage at which the item is taxed
tax_type
string
Type of tax. It can either Tax or Group Tax
purchase_account_id
long
Unique ID generated by the server for the type of purchase
purchase_account_name
string
Type of purchase under which the composite item was bought
account_id
long
Unique ID generated by the server for the type of sale of this item
account_name
string
Type of sale under which the composite item is sold
inventory_account_id
long
Unique ID generated by the server for the type of inventory for this item
inventory_account_name
string
Name of inventory type
status
string
Status of the Item
source
string
source
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
item_type
string
(Required)
Type of item Always inventory
rate
double
(Required)
Selling price of the item
pricebook_rate
double
Price list applied on the item's selling price.
purchase_rate
double
Buying price of the item
reorder_level
double
Reorder point of the item
initial_stock
double
Initial stock of item
initial_stock_rate
double
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
vendor_id
long
Unique ID generated by the server for preferred vendor to buy this composite item
vendor_name
string
Name of the preferred vendor
stock_on_hand
double
Stock based on Invoices and Bills
asset_value
double
value of the composite items based on purchase rate
available_stock
double
Stock based on Shipments and Receives
actual_available_stock
double
Stock based on Shipments and Receives minus ordered stock
sku
string
(Required)
Stock Keeping Unit value of the item. It should be unique throughout the product
upc
long
Unique Product Code, 12 digit unique code of the item
ean
long
European Article Number, 13 digit barcode number of the item
isbn
long
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
part_number
string
MPN - Manufacturing Part Number, unambiguously identifies a part design
image_id
long
Unique identifier generated by the server for item image
image_name
string
Name of the image
purchase_description
string
Purchase description of the item
custom_fields
array
Custom fields are used to add more information about the item
Show Sub-Attributes arrow
custom_field_id
long
Unique ID generated by the server for the custom field.
value
string
Value of the custom field.
index
integer
Index of the custom field. It can hold any value from 1 to 10.
label
string
Label of the custom field.
mapped_items
array
(Required)
Items that are associated with the composite item
Show Sub-Attributes arrow
line_item_id
long
Unique ID generated by the server for mapping the associated item with composite item
item_id
long
Unique ID generated by the server for the Item. This is used as an identifier.
name
string
(Required)
Name of the composite item
rate
double
(Required)
Selling price of the item
purchase_rate
double
Buying price of the item
sku
string
(Required)
Stock Keeping Unit value of the item. It should be unique throughout the product
image_id
long
Unique identifier generated by the server for item image
image_name
string
Name of the image
purchase_description
string
Purchase description of the item
image_type
string
Type of the image Only images with gif,png,jpeg,jpg,bmp extensions are allowed
unit
string
Unit of Item
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
description
string
Sample Description.
quantity
double
Quantity of item associated with the composite item
stock_on_hand
double
Stock based on Invoices and Bills
available_stock
double
Stock based on Shipments and Receives
actual_available_stock
double
Stock based on Shipments and Receives minus ordered stock
item_tax_preferences
array
🇮🇳 India
only
List of tax preferences of the item
Show Sub-Attributes arrow
tax_id
long
Unique ID generated by the server for the tax .
tax_specification
string
🇮🇳 India
only
Type of tax. It can be intra or inter
hsn_or_sac
string
🇮🇳 India
only
HSN Code of the item
product_type
string
(Required)
Type of the product.

Path Parameters

composite_item_id
string
(Required)
Unique identifier of the composite item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

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

Body Parameters

Click to copy
{ "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Just a sample description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "asset_value": 0.1, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 4815000000044208, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Just a sample description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ], "item_tax_preferences": [ { "tax_id": 504366000000053100, "tax_specification": "intra" } ], "hsn_or_sac": 85423100, "product_type": "goods" }

Response Example

{ "code": 0, "message": "Item details have been saved.", "composite_item": { "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "unit": "units", "tax_id": 504366000000053100, "description": "Just a sample description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "status": "active", "source": "user", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "asset_value": 0.1, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 4815000000044208, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Just a sample description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ], "item_tax_preferences": [ { "tax_id": 504366000000053100, "tax_specification": "intra" } ], "hsn_or_sac": 85423100 } }

Retrieving a Composite Item

Retrieving details of an existing compostie item.
OAuth Scope : ZohoInventory.compositeitems.READ

Path Parameters

composite_item_id
string
(Required)
Unique identifier of the composite item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/compositeitems/504366000000053250?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/compositeitems/504366000000053250?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "composite_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "status": "active", "source": "user", "unit": "units", "tax_id": 504366000000053100, "description": "Just a sample description", "tax_name": "VAT", "tax_percentage": 13, "tax_type": "tax", "purchase_account_id": 504366000000034000, "purchase_account_name": "Cost of Goods Sold", "account_id": 504366000000000400, "account_name": "sales", "inventory_account_id": 504366000000034000, "inventory_account_name": "Inventory Asset", "is_combo_product": true, "item_type": "inventory", "rate": 85000, "pricebook_rate": 85000, "purchase_rate": 30000, "reorder_level": 1, "initial_stock": 2, "initial_stock_rate": 30000, "vendor_id": 504366000000053250, "vendor_name": "Mr. vendor combo", "stock_on_hand": 2, "asset_value": 0.1, "available_stock": 2, "actual_available_stock": 2, "sku": "SKUIS", "upc": 746325287436, "ean": 5789414385764, "isbn": 368302334, "part_number": "JHFKE7GK7", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "custom_fields": [ { "custom_field_id": 504366000000053400, "value": "GBGD078", "index": 1, "label": "VAT ID" } ], "mapped_items": [ { "line_item_id": 504366000000053250, "item_id": 4815000000044208, "name": "Combo of Apple IPhone and Smartwatch", "rate": 85000, "purchase_rate": 30000, "sku": "SKUIS", "image_id": 8408722000000019000, "image_name": "img1.jpg", "purchase_description": "Composite item purchase description", "image_type": "jpg", "unit": "units", "is_combo_product": true, "description": "Just a sample description", "quantity": 1, "stock_on_hand": 2, "available_stock": 2, "actual_available_stock": 2 } ], "item_tax_preferences": [ { "tax_id": 504366000000053100, "tax_specification": "intra" } ], "hsn_or_sac": 85423100 }

Deleting a Composite Item

Deleting an existing Composite Item.
OAuth Scope : ZohoInventory.compositeitems.DELETE

Path Parameters

composite_item_id
string
(Required)
Unique identifier of the composite item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/inventory/v1/compositeitems/504366000000053250?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/compositeitems/504366000000053250?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request DELETE \ --url 'https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Mark as Active

Changing status of an existing composite item to active.
OAuth Scope : ZohoInventory.compositeitems.CREATE

Path Parameters

composite_item_id
string
(Required)
Unique identifier of the composite item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/active?organization_id=10234695" type: POST headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/active?organization_id=10234695") .post(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/active?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("POST", "/inventory/v1/compositeitems/504366000000053250/active?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/compositeitems/504366000000053250/active?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request POST \ --url 'https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/active?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Re-activation complete! The item is back in business!" }

Mark as Inactive

Changing status of an existing composite item to inactive.
OAuth Scope : ZohoInventory.compositeitems.CREATE

Path Parameters

composite_item_id
string
(Required)
Unique identifier of the composite item.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/inactive?organization_id=10234695" type: POST headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/inactive?organization_id=10234695") .post(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/inactive?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("POST", "/inventory/v1/compositeitems/504366000000053250/inactive?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/compositeitems/504366000000053250/inactive?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request POST \ --url 'https://www.zohoapis.com/inventory/v1/compositeitems/504366000000053250/inactive?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Create Assemblies

Assemblies is the technique of putting together different components in desired quantities to produce a single commodity. These components could be goods, services and other non-inventory items of your choice.
OAuth Scope : ZohoInventory.compositeitems.CREATE

Arguments

reference_number
string
(Required)
Reference number for the Assemblies.
date
date
(Required)
The date on which Assemblies is done
description
string
Sample Description.
composite_item_id
long
(Required)
Unique ID generated for the composite item by the server. This is used as identifier
composite_item_name
string
(Required)
Name of the composite item
composite_item_sku
string
Stock Keeping Unit value of the composite item. It should be unique throughout the product
quantity_to_bundle
double
(Required)
Quantity of Assembly to be Assembled.
line_items
array
(Required)
A assemblies can contain multiple line items. Each line item contains item_id,name,description,quantity_consumed,unit,account_id,location_id.
Show Sub-Attributes arrow
item_id
long
(Required)
Unique ID generated by the server for the Item. This is used as an identifier.
name
string
(Required)
Name of the composite item
description
string
Sample Description.
quantity_consumed
double
(Required)
Quantity of item to be Assembled.
unit
string
Unit of Item
account_id
long
(Required)
Unique ID generated by the server for the type of sale of this item
account_name
string
Type of sale under which the composite item is sold
location_id
string
(Required)
Location ID
location_name
string
Name of the location
rate
double
Selling price of the item
is_completed
boolean
(Required)
Denotes the status of the assemblies. Currently, this has to be true since we didnt support any other status as of now.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

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

Body Parameters

Click to copy
{ "reference_number": "REF-B-00005", "date": "2017-01-05", "description": "Just a sample description", "composite_item_id": 504366000000053250, "composite_item_name": "Combo of Apple IPhone and Smartwatch", "composite_item_sku": "SKUIS", "quantity_to_bundle": 1, "line_items": [ { "item_id": 4815000000044208, "name": "Combo of Apple IPhone and Smartwatch", "description": "Just a sample description", "quantity_consumed": 1, "unit": "units", "account_id": 504366000000000400, "account_name": "sales", "location_id": "460000000038080", "location_name": "Head Office", "rate": 85000 } ], "is_completed": true }

Response Example

{ "code": 0, "message": "Assembly has been created.", "bundle_id": 504366000000053250, "reference_number": "REF-B-00005", "date": "2017-01-05", "description": "Just a sample description", "composite_item_id": 504366000000053250, "composite_item_name": "Combo of Apple IPhone and Smartwatch", "composite_item_sku": "SKUIS", "quantity_to_bundle": 1, "line_items": [ { "item_id": 4815000000044208, "line_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "description": "Just a sample description", "quantity_consumed": 1, "unit": "units", "account_id": 504366000000000400, "account_name": "sales", "location_id": "460000000038080", "location_name": "Head Office", "rate": 85000 } ] }

Assemblies History

List of all Assemblies of a given composite item.
OAuth Scope : ZohoInventory.compositeitems.READ

Query Parameters

organization_id
string
(Required)
ID of the organization
composite_item_id
long
(Required)
Unique ID generated for the composite item by the server. This is used as identifier
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/bundles?organization_id=10234695&composite_item_id=504366000000053250" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/bundles?organization_id=10234695&composite_item_id=504366000000053250") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/bundles?organization_id=10234695&composite_item_id=504366000000053250', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/bundles?organization_id=10234695&composite_item_id=504366000000053250", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/bundles?organization_id=10234695&composite_item_id=504366000000053250", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.com/inventory/v1/bundles?organization_id=10234695&composite_item_id=504366000000053250' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "bundles": [ { "bundle_id": 504366000000053250, "reference_number": "REF-B-00005", "date": "2017-01-05", "description": "Just a sample description", "composite_item_id": 504366000000053250, "composite_item_name": "Combo of Apple IPhone and Smartwatch", "composite_item_sku": "SKUIS", "quantity_to_bundle": 1, "line_items": [ { "item_id": 4815000000044208, "line_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "description": "Just a sample description", "quantity_consumed": 1, "unit": "units", "account_id": 504366000000000400, "account_name": "sales", "location_id": "460000000038080", "location_name": "Head Office", "rate": 85000 } ] }, {...}, {...} ] }

Retrieve Assemblies

Fetches the details for an existing Assemblies.
OAuth Scope : ZohoInventory.compositeitems.READ

Path Parameters

bundle_id
string
(Required)
Unique identifier of the bundle.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/bundles/504366000000053250?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/bundles/504366000000053250?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "bundle": { "bundle_id": 504366000000053250, "reference_number": "REF-B-00005", "date": "2017-01-05", "description": "Just a sample description", "composite_item_id": 504366000000053250, "composite_item_name": "Combo of Apple IPhone and Smartwatch", "composite_item_sku": "SKUIS", "quantity_to_bundle": 1, "line_items": [ { "item_id": 4815000000044208, "line_item_id": 504366000000053250, "name": "Combo of Apple IPhone and Smartwatch", "description": "Just a sample description", "quantity_consumed": 1, "unit": "units", "account_id": 504366000000000400, "account_name": "sales", "location_id": "460000000038080", "location_name": "Head Office", "rate": 85000 } ], "is_completed": true } }

Delete Assemblies

Deletes an existing Assemblies from Zoho Inventory.
OAuth Scope : ZohoInventory.compositeitems.DELETE

Path Parameters

bundle_id
string
(Required)
Unique identifier of the bundle.

Query Parameters

organization_id
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/inventory/v1/bundles/504366000000053250?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/bundles/504366000000053250?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request DELETE \ --url 'https://www.zohoapis.com/inventory/v1/bundles/504366000000053250?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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