Cmdlets for Zoho CRM

Build 25.0.9434

Products

Stores product catalog records including item name, SKU, price, and stock information.

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 record.

ProductOwner_Id String False

Identifier of the user who owns the product record.

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 for identification.

VendorName_Id String False

Identifier of the vendor supplying the product.

VendorName_Name String True

Name of the vendor supplying 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 or classification of the product.

SalesStartDate Date False

Date when the product became available for sale.

SalesEndDate Date False

Date when the product was discontinued or removed from sale.

SupportStartDate Date False

Start date for the product's support period.

SupportEndDate Date False

End date for the product's support period.

CreatedBy_Id String False

Identifier of 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

Identifier of 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

Timestamp indicating when the product record was created.

ModifiedTime Datetime False

Timestamp indicating when the product record was last modified.

Tag String False

Comma-separated list of tags associated with the product.

UnitPrice Decimal False

Price per unit of the product.

CommissionRate Decimal False

Commission rate applicable to the product.

Tax String False

Comma-separated list of taxes applicable to the product.

Taxable Bool False

Indicates whether the product is taxable.

UsageUnit String False

Unit of measurement used for product quantity.

QtyOrdered Double False

Total quantity of the product that has been ordered.

QuantityinStock Double False

Current quantity of the product available in stock.

ReorderLevel Double False

Stock level at which a reorder is initiated.

Handler_Id String False

Identifier of the user responsible for handling the product.

Handler_Name String True

Name of the user responsible for handling the product.

QuantityinDemand Double False

Quantity of the product currently in demand.

Description String False

Detailed description of the product.

ProductImage String False

Link or reference to the product image.

Locked Bool True

Indicates whether the product record is locked from editing.

LastActivityTime Datetime False

Timestamp of the most recent activity related to the 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

Field or fields used to identify duplicate product records during an upsert. Multiple fields are supported in the REST API, but only one is allowed in the BULK API.

Trigger String

Specifies whether to trigger automation or workflow rules when inserting the record.

CustomViewId Long

Identifier of the custom view used to filter this record. Applies only when the useCOQL parameter is set to false.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434