Zoho Inventory compositeitems API
CompositeItems Module
Zoho Inventory compositeitems API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include compositeitems. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 16 operations across 9 paths, and defines 93 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
16 operations
9 paths
93 schemas
3 DELETE4 GET7 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory compositeitems API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 16
Across 9 paths, the API surfaces 16 operations — 3 DELETE, 4 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
compositeitems 16
CompositeItems Module
POST
/compositeitems
Creating a Composite Item
GET
/compositeitems
List All Composite Items
GET
/compositeitems/{composite_item_id}
Retrieving a Composite Item
PUT
/compositeitems/{composite_item_id}
Updating a composite item
DELETE
/compositeitems/{composite_item_id}
Deleting a Composite Item
POST
/compositeitems/{composite_item_id}/active
Mark as Active
POST
/compositeitems/{composite_item_id}/inactive
Mark as Inactive
POST
/compositeitems/{composite_item_id}/image
Upload Composite Item Images
DELETE
/compositeitems/{composite_item_id}/image
Delete Composite Item Image
POST
/bundles
Create Assemblies
GET
/bundles
Assemblies History
GET
/bundles/{bundle_id}
Retrieve Assemblies
PUT
/bundles/{bundle_id}
Update an Assembly
DELETE
/bundles/{bundle_id}
Delete Assemblies
POST
/bundles/{bundle_id}/bundled
Mark Assembly as Assembled
POST
/bundles/{bundle_id}/confirmed
Mark Assembly as Confirmed
Schemas 93
The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are retrieving-a-composite-item-response (73 properties), composite_item (52 properties), updating-a-composite-item-request (44 properties), creating-a-composite-item-request (43 properties). Each schema is shown below with its type and property counts.
deleting-a-composite-item-response
object
2 properties
composite_item_id
string
Unique ID generated for the composite item by the server. This is used as identifier
updating-a-composite-item-request
object
44 properties
6 required
ean
string
European Article Number, 13 digit barcode number of the item
inventory_account_name
string
Name of inventory type
vendor_name
string
Name of the preferred vendor
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
mark-as-active-response
object
2 properties
available_stock
number
Stock based on Shipments and Receives
item_id
string
Unique ID generated by the server for the Item. This is used as an identifier.
bundle_id
string
Unique ID generated for the Assemblies by the server. This is used as identifier
updating-a-composite-item-response
object
3 properties
account_id
string
Unique ID generated by the server for the type of sale of this item
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
date
string
The date on which Assemblies is done
purchase_account_id
string
Unique ID generated by the server for the type of purchase
purchase_rate
number
Buying price of the item
custom_fields
array
Custom fields are used to add more information about the item
item_type
string
Type of item Always inventory
value
string
Value of the custom field.
tax_specification
string
Type of tax. It can be intra or inter
create-bundle-request
object
16 properties
7 required
inventory_account_id
string
Unique ID generated by the server for the type of inventory for this item
update-bundle-request
object
mark-as-inactive-response
object
2 properties
stock_on_hand
number
Stock based on Invoices and Bills
status
string
Status of the Item
label
string
Label of the custom field.
hsn_or_sac
string
HSN Code of the item
delete-composite-item-image-response
object
2 properties
composite_item_sku
string
Stock Keeping Unit value of the composite item. It should be unique throughout the product
quantity
number
Quantity of item associated with the composite item
is_completed
boolean
Denotes the status of the assemblies. Currently, this has to be true since we didnt support any other status as of now.
retrieving-a-composite-item-response
object
73 properties
name
string
Name of the composite item
part_number
string
MPN - Manufacturing Part Number, unambiguously identifies a part design
tax_percentage
number
Percentage at which the item is taxed
creating-a-composite-item-response
object
3 properties
upload-composite-item-image-response
object
2 properties
bundling-history-response
object
4 properties
mark-assembly-as-built-response
object
3 properties
line_item_id
string
Unique ID generated by the server for mapping the associated item with composite item
finished_product_batches
array
Batches to be created for the finished product. Use when the composite item has batch tracking enabled.
reference_number
string
Reference number for the Assemblies.
location_id
string
Location ID
quantity_to_bundle
number
Quantity of Assembly to be Assembled.
description
string
Sample Description.
purchase_description
string
Purchase description of the item
storages
array
Bin/storage locations consumed for the line item. Applicable only for items with bin tracking enabled.
line_items
array
A assemblies can contain multiple line items. Each line item contains itemid , name , description , quantityconsumed , unit , accountid , locationid .
asset_value
number
value of the composite items based on purchase rate
last_modified_time
string
Search using the Last Modified Time of the Base Currency Adjustment
sku
string
Stock Keeping Unit value of the item. It should be unique throughout the product
update-bundle-response
object
3 properties
composite_item
object
52 properties
list-all-composite-items-response
object
4 properties
image_id
string
Unique identifier generated by the server for item image
initial_stock_rate
number
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
initial_stock
number
Initial stock of item
is_taxable
boolean
To check if the item is taxable or not true if the item is taxable, else false
finished_product_storages
array
Bin/storage locations to store the finished product. Use when the composite item has bin tracking enabled.
unit
string
Unit of Item
created_time
string
Time at which the contact was created.
image_type
string
Type of the image Only images with gif,png,jpeg,jpg,bmp extensions are allowed
upc
string
Unique Product Code, 12 digit unique code of the item
rate
number
Selling price of the item
product_type
string
Type of the product.
reorder_level
number
Reorder point of the item
tax_id
string
Unique ID generated by the server for the tax .
page_context
object
7 properties
composite_item_name
string
Name of the composite item
creating-a-composite-item-request
object
43 properties
6 required
location_name
string
Name of the location
isbn
string
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
pricebook_rate
number
Price list applied on the item's selling price.
delete-bundle-response
object
2 properties
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
retrieve-bundle-response
object
3 properties
purchase_account_name
string
Type of purchase under which the composite item was bought
customfield_id
string
Unique ID generated by the server for the custom field.
finished_product_serial_numbers
array
Serial numbers to be assigned to the finished product. Use when the composite item has serial tracking enabled.
image_name
string
Name of the image
create-bundle-response
object
20 properties
actual_available_stock
number
Stock based on Shipments and Receives minus ordered stock
item_tax_preferences
array
List of tax preferences of the item
account_name
string
Type of sale under which the composite item is sold
mapped_items
array
Items that are associated with the composite item
tax_type
string
Type of tax. It can either Tax or Group Tax
source
string
source
quantity_consumed
number
Quantity of item to be Assembled.
mark-assembly-as-confirmed-response
object
3 properties
tax_name
string
Name of the tax applied on selling this item
vendor_id
string
Unique ID generated by the server for preferred vendor to buy this composite item
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
Zoho Inventory items API
#compositeitems