CompositeItems
List, Insert, Update, delete CompositeItems
Table Specific Information
Select
The add-in will use the Zoho Inventory API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the add-in.
- Id supports the '=' comparison.
- LastModifiedTime supports the '=' comparison.
- Name supports the '=' comparison.
- PurchaseRate supports the '=' comparison.
- Rate supports the '=' comparison.
- Sku supports the '=' comparison.
- Source supports the '=' comparison.
- TaxName supports the '=' comparison.
For example, the following queries are processed server side:
SELECT * FROM CompositeItems WHERE Id = '3350895000000089001' SELECT * FROM CompositeItems WHERE LastModifiedTime = '2013-08-05' SELECT * FROM CompositeItems WHERE Name = 'new' SELECT * FROM CompositeItems WHERE PurchaseRate = '66' SELECT * FROM CompositeItems WHERE Rate = '76' SELECT * FROM CompositeItems WHERE Sku = '23' SELECT * FROM CompositeItems WHERE Source = 'abc' SELECT * FROM CompositeItems WHERE TaxName = 'tax'
Insert
Insert can be executed by specifying the Name, MappedItems, Sku, Rate and ItemType column. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.
INSERT INTO CompositeItems (Name, ItemType, Rate, MappedItems) VALUES ('PQRstub', 'inventory', '1999', '[ {\"item_id\": 3285934000000104097, \"quantity\": 3}]')
Update
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE CompositeItems SET Name = 'test2' WHERE Id = '3285934000000136008'
Delete
Delete can be executed by specifying the Id in the WHERE Clause
For example:
DELETE FROM CompositeItems WHERE Id = '3350895000000089001'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
Unique ID generated for the composite item by the server. | |
| ActualAvailableStock | Integer | True |
Stock based on Shipments and Receives minus ordered stock. | |
| AvailableStock | Integer | True |
Stock based on Shipments and Receives. | |
| AssetValue | Double | True |
value of the composite items based on purchase rate | |
| CreatedTime | Datetime | True |
Automatically generated time when item was created. | |
| description | String | False |
Sample description. | |
| Ean | Long | False |
European Article Number, 13 digit barcode number of the item | |
| HsnorSac | String | False |
HSN Code of the item | |
| ImageId | Long | True |
Unique identifier generated by the server for item image. | |
| ImageName | String | True |
Name of the image. | |
| AccountId | Long | False |
Unique ID generated by the server for the type of sale of this item | |
| InventoryAccountId | Long | False |
Unique ID generated by the server for the type of inventory for this item | |
| InventoryAccountName | String | True |
Name of inventory type | |
| IsComboProduct | Boolean | False |
Defines whether the item is composite or not. | |
| IsTaxable | Boolean | True |
is taxable. | |
| InitialStock | Integer | False |
Initial stock of item | |
| InitialStockRate | Integer | False |
Average purchase price of initial stock. | |
| Isbn | Integer | False |
International Standard Book Number, 13 digit unique commercial book identifier barcode of the item. | |
| ItemType | String | False |
Type of item Always inventory | |
| LastModifiedTime | Datetime | True |
last modified time. | |
| MappedItems | String | False |
Items that are associated with the composite item. | |
| ItemTaxPreferences | String | False |
Item Tax Preferences that are associated with the composite item. | |
| CustomFields | String | False |
Custom fields are used to add more information about the item | |
| Name | String | False |
Name of the composite item. | |
| PartNumber | String | False |
MPN - Manufacturing Part Number, unambiguously identifies a part design. | |
| ProductType | String | True |
product type. | |
| Purchasedescription | String | False |
Purchase desc of the item. | |
| PurchaseRate | Integer | False |
Buying price of the item. | |
| PurchaseAccountId | Long | False |
Unique ID generated by the server for the type of purchase. | |
| PurchaseAccountName | String | True |
Type of purchase under which the composite item was bought | |
| PricebookRate | Integer | False |
Price list applied on the item selling price. | |
| Rate | Integer | False |
Selling price of the item. | |
| ReorderLevel | Integer | False |
Reorder point of the item. | |
| Sku | String | False |
Stock Keeping Unit value of the item. It should be unique throughout the product. | |
| Source | String | True |
source. | |
| Status | String | True |
Status of the Item. | |
| StockOnHand | Integer | True |
Stock based on Invoices and Bills. | |
| TaxId | Long | False |
Taxes.Id |
Unique ID generated by the server for the tax .. |
| TaxName | String | True |
Name of the tax applied on selling this item. | |
| TaxPercentage | Integer | True |
Percentage at which the item is taxed. | |
| Upc | Long | False |
Unique Product Code, 12 digit unique code of the item. | |
| Unit | String | False |
Unit of the Item. | |
| VendorId | Long | False |
Taxes.Id |
ID of the vendor the vendor credit is associated with. |
| OrganizationId | String | True |
ID of the Organization | |
| VendorName | String | True |
Name of the Vendor Associated with the Vendor Credit | |
| CompositeItemsFilter | String | True |
Filter items by status The allowed values are Status.All, Status.Active, Status.Inactive, Status.Lowstock. | |
| AccountName | String | True |
Name of the account. | |
| ActualAvailableForSaleStock | Double | True |
Actual available for sale stock. | |
| AttributeOptionData1 | String | True |
Attribute option data 1. | |
| AttributeOptionData2 | String | True |
Attribute option data 2. | |
| AttributeOptionData3 | String | True |
Attribute option data 3. | |
| CategoryId | Long | True |
ID of the category. | |
| ChannelPreferences | String | True |
Channel preferences. | |
| ComboType | String | True |
Type of combo product. | |
| Documents | String | True |
Documents. | |
| EntityTags | String | True |
Entity tags. | |
| ItemCode | String | True |
Code of the item. | |
| PackageDetails | String | True |
Package details. | |
| ProductTags | String | True |
Product tags. | |
| PurposeOfUse | String | True |
Purpose of use. | |
| SalesChannels | String | True |
Sales channels. | |
| Specifications | String | True |
Specifications. | |
| ActualCommittedStock | Double | True |
Actual committed stock. | |
| AttributeId1 | Long | True |
ID of attribute 1. | |
| AttributeId2 | Long | True |
ID of attribute 2. | |
| AttributeId3 | Long | True |
ID of attribute 3. | |
| AttributeName1 | String | True |
Name of attribute 1. | |
| AttributeName2 | String | True |
Name of attribute 2. | |
| AttributeName3 | String | True |
Name of attribute 3. | |
| AttributeOptionId1 | Long | True |
ID of attribute option 1. | |
| AttributeOptionId2 | Long | True |
ID of attribute option 2. | |
| AttributeOptionId3 | Long | True |
ID of attribute option 3. | |
| AttributeOptionName1 | String | True |
Name of attribute option 1. | |
| AttributeOptionName2 | String | True |
Name of attribute option 2. | |
| AttributeOptionName3 | String | True |
Name of attribute option 3. | |
| AttributeType1 | String | True |
Type of attribute 1. | |
| AttributeType2 | String | True |
Type of attribute 2. | |
| AttributeType3 | String | True |
Type of attribute 3. | |
| AvailableForSaleStock | Double | True |
Available for sale stock. | |
| CategoryName | String | True |
Name of the category. | |
| CommittedStock | Double | True |
Committed stock. | |
| CompositeComponentItems | String | True |
Composite component items. | |
| CompositeServiceItems | String | True |
Composite service items. | |
| GroupId | Long | True |
ID of the group. | |
| GroupName | String | True |
Name of the group. | |
| IsBoxingExist | Boolean | True |
Whether boxing exists. | |
| KitAvailableForSaleStock | Double | True |
Kit available for sale stock. | |
| KitQuantity | Double | True |
Kit quantity. | |
| LabelRate | Double | True |
Label rate. | |
| MaximumOrderQuantity | Double | True |
Maximum order quantity. | |
| MinimumOrderQuantity | Double | True |
Minimum order quantity. | |
| OfflineCreatedDateWithTime | Datetime | True |
Offline created date with time. | |
| PageLayoutId | Long | True |
ID of the page layout. | |
| PreferredVendors | String | True |
Preferred vendors. | |
| ProductDescription | String | True |
Product description. | |
| ProductShortDescription | String | True |
Product short description. | |
| ProductSubtype | String | True |
Subtype of the product. | |
| SalesMargin | Double | True |
Sales margin. | |
| SeoDescription | String | True |
SEO description. | |
| SeoKeyword | String | True |
SEO keyword. | |
| SeoTitle | String | True |
SEO title. | |
| ShowInStorefront | Boolean | True |
Whether shown in storefront. | |
| SpecificationsetId | Long | True |
ID of the specification set. | |
| SpecificationsetName | String | True |
Name of the specification set. | |
| Tags | String | True |
Tags. | |
| TaxType | String | True |
Type of the tax. | |
| Url | String | True |
URL. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| SearchText | String |
Search composite items by name or other attributes. |
| ResponseOption | Integer |
Response format number. |
| WarehouseId | Long |
Filter composite items by warehouse ID. |
| LocationId | Long |
Filter composite items by location ID. |