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.2.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
The identity and technical contract details declared by the specification.
mark-assembly-as-built-response
object
3 properties
pricebook_rate
number
Price list applied on the item's selling price.
mark-assembly-as-confirmed-response
object
3 properties
upc
string
Unique Product Code, 12 digit unique code of the item
account_id
string
Unique ID generated by the server for the type of sale of this item
composite_item
object
52 properties
composite_item_sku
string
Stock Keeping Unit value of the composite item. It should be unique throughout the product
tax_type
string
Type of tax. It can either Tax or Group Tax
location_id
string
Location ID
creating-a-composite-item-request
object
43 properties
6 required
location_name
string
Name of the location
available_stock
number
Stock based on Shipments and Receives
isbn
string
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item
bundling-history-response
object
4 properties
create-bundle-response
object
20 properties
tax_name
string
Name of the tax applied on selling this item
purchase_account_name
string
Type of purchase under which the composite item was bought
is_combo_product
boolean
Defines whether the item is composite or not true for composite items
updating-a-composite-item-response
object
3 properties
retrieve-bundle-response
object
3 properties
purchase_rate
number
Buying price of the item
finished_product_storages
array
Bin/storage locations to store the finished product. Use when the composite item has bin tracking enabled.
sku
string
Stock Keeping Unit value of the item. It should be unique throughout the product
item_tax_preferences
array
List of tax preferences of the item
part_number
string
MPN - Manufacturing Part Number, unambiguously identifies a part design
upload-composite-item-image-response
object
2 properties
image_type
string
Type of the image Only images with gif,png,jpeg,jpg,bmp extensions are allowed
initial_stock
number
Initial stock of item
description
string
Sample Description.
line_item_id
string
Unique ID generated by the server for mapping the associated item with composite item
name
string
Name of the composite item
image_id
string
Unique identifier generated by the server for item image
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.
create-bundle-request
object
16 properties
7 required
quantity
number
Quantity of item associated with the composite item
image_name
string
Name of the image
inventory_account_name
string
Name of inventory type
actual_available_stock
number
Stock based on Shipments and Receives minus ordered stock
stock_on_hand
number
Stock based on Invoices and Bills
rate
number
Selling price of the item
inventory_account_id
string
Unique ID generated by the server for the type of inventory for this item
updating-a-composite-item-request
object
44 properties
6 required
initial_stock_rate
number
Average purchase price of initial stock. This is required for FIFO cost lot tracking and inventory valuation
mark-as-active-response
object
2 properties
custom_fields
array
Custom fields are used to add more information about the item
mapped_items
array
Items that are associated with the composite item
vendor_id
string
Unique ID generated by the server for preferred vendor to buy this composite item
product_type
string
Type of the product.
delete-composite-item-image-response
object
2 properties
item_type
string
Type of item Always inventory
composite_item_name
string
Name of the composite item
update-bundle-response
object
3 properties
status
string
Status of the Item
deleting-a-composite-item-response
object
2 properties
label
string
Label of the custom field.
tax_percentage
number
Percentage at which the item is taxed
list-all-composite-items-response
object
4 properties
quantity_consumed
number
Quantity of item to be Assembled.
line_items
array
A assemblies can contain multiple line items. Each line item contains itemid , name , description , quantityconsumed , unit , accountid , locationid .
date
string
The date on which Assemblies is done
purchase_account_id
string
Unique ID generated by the server for the type of purchase
update-bundle-request
object
reference_number
string
Reference number for the Assemblies.
retrieving-a-composite-item-response
object
73 properties
last_modified_time
string
Search using the Last Modified Time of the Base Currency Adjustment
is_taxable
boolean
To check if the item is taxable or not true if the item is taxable, else false
ean
string
European Article Number, 13 digit barcode number of the item
delete-bundle-response
object
2 properties
vendor_name
string
Name of the preferred vendor
created_time
string
Time at which the contact was created.
tax_specification
string
Type of tax. It can be intra or inter
finished_product_serial_numbers
array
Serial numbers to be assigned to the finished product. Use when the composite item has serial tracking enabled.
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
hsn_or_sac
string
HSN Code of the item
reorder_level
number
Reorder point of the item
item_id
string
Unique ID generated by the server for the Item. This is used as an identifier.
account_name
string
Type of sale under which the composite item is sold
tax_id
string
Unique ID generated by the server for the tax .
finished_product_batches
array
Batches to be created for the finished product. Use when the composite item has batch tracking enabled.
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
asset_value
number
value of the composite items based on purchase rate
mark-as-inactive-response
object
2 properties
customfield_id
string
Unique ID generated by the server for the custom field.
value
string
Value of the custom field.
composite_item_id
string
Unique ID generated for the composite item by the server. This is used as identifier
purchase_description
string
Purchase description of the item
bundle_id
string
Unique ID generated for the Assemblies by the server. This is used as identifier
quantity_to_bundle
number
Quantity of Assembly to be Assembled.
page_context
object
7 properties
storages
array
Bin/storage locations consumed for the line item. Applicable only for items with bin tracking enabled.
creating-a-composite-item-response
object
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
