Products
Contains product catalog entries, including SKU, category, price, and stock; unavailable in free or standard editions.
Table-Specific Information
The Products table is only accessible when connected to a ZohoCRM Enterprise Edition account. If using a different edition, this table may not be available.Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
The following example demonstrates a basic insert operation:
-- Insert a new product and mark it as active
INSERT INTO Products (ProductName, ProductActive) VALUES ('C-3PO', true)
Required fields: ProductName is required. This is the name of the product and must be provided to create a new record.
Any field which is not read-only (ReadOnly = false in the table schema) can be inserted.
Delete
You must specify the Id column in the WHERE clause to delete a record. The following example demonstrates a delete operation:
-- Delete a product by its unique ID
DELETE FROM Products WHERE Id = '3152079000000153079'
Update
You must specify the Id column in the WHERE clause to update a record. The following example demonstrates an update operation:
-- Update the description for a specific product using its ID
UPDATE Products SET Description = 'Changed from the API.' WHERE Id = '3152079000000487023'
Required fields: Id is required. The update must target a specific record.
Any field which is not read-only (ReadOnly = false in the table schema) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier for the product. |
| ProductOwner_Id | String | False |
Unique identifier for the user who owns the product. |
| ProductOwner_FirstName | String | True |
First name of the product owner. |
| ProductOwner_LastName | String | True |
Last name of the product owner. |
| ProductOwner_Email | String | True |
Email address of the product owner. |
| ProductOwner_Name | String | True |
Full name of the product owner. |
| ProductName | String | False |
Name of the product. |
| ProductCode | String | False |
Code assigned to the product. |
| VendorName_Id | String | False |
Unique identifier of the vendor associated with the product. |
| VendorName_Name | String | True |
Name of the vendor associated with the product. |
| ProductActive | Bool | False |
Indicates whether the product is currently active. |
| Manufacturer | String | False |
Name of the manufacturer of the product. |
| ProductCategory | String | False |
Category to which the product belongs. |
| SalesStartDate | Date | False |
Date on which sales for this product began. |
| SalesEndDate | Date | False |
Date on which sales for this product ended or will end. |
| SupportStartDate | Date | False |
Date on which support for this product began. |
| SupportEndDate | Date | False |
Date on which support for this product ends or ended. |
| CreatedBy_Id | String | False |
Unique identifier for the user who created the product record. |
| CreatedBy_FirstName | String | True |
First name of the user who created the product record. |
| CreatedBy_LastName | String | True |
Last name of the user who created the product record. |
| CreatedBy_Email | String | True |
Email address of the user who created the product record. |
| CreatedBy_Name | String | True |
Full name of the user who created the product record. |
| ModifiedBy_Id | String | False |
Unique identifier for the user who last modified the product record. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the product record. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the product record. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the product record. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the product record. |
| CreatedTime | Datetime | False |
Date and time when the product record was created. |
| ModifiedTime | Datetime | False |
Date and time when the product record was last modified. |
| Tag | String | False |
Tag associated with the product. |
| UnitPrice | Decimal | False |
Unit price of the product. |
| CommissionRate | Decimal | False |
Commission rate applicable to the product. |
| Tax | String | False |
Tax details associated with the product. |
| Taxable | Bool | False |
Indicates whether the product is taxable. |
| UsageUnit | String | False |
Unit used to measure the product. |
| QtyOrdered | Double | False |
Total quantity of the product that has been ordered. |
| QuantityinStock | Double | False |
Current stock quantity available for the product. |
| ReorderLevel | Double | False |
Stock level at which a reorder is placed. |
| Handler_Id | String | False |
Unique identifier for the user handling the product. |
| Handler_Name | String | True |
Full name of the user handling the product. |
| QuantityinDemand | Double | False |
Quantity of the product currently in demand. |
| Description | String | False |
Description of the product. |
| ProductImage | String | False |
Image of the product. |
| Locked | Bool | True |
Indicates whether the product record is locked from editing. |
| LastActivityTime | Datetime | False |
Date and time of the last activity related to this product. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
The field or fields used to check for duplicate records during an upsert. The REST API supports multiple fields, while the BULK API supports only one. |
| Trigger | String |
Used to trigger rules when inserting a record into the CRM account. |
| CustomViewId | Long |
The custom view identifier used to filter this record. Works only when the useCOQL parameter is false. |