Products
Create, update, delete, and query information regarding products.
Table-Specific Information
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
INSERT INTO Products(ProductName, ProductActive) VALUES('C-3PO', true)
Required fields: ProductName.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Products WHERE Id = '3152079000000153079'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Products SET Description = 'Changed from the API.' WHERE Id = '3152079000000487023'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for this record. |
| ProductOwner_Id | String | False |
The Id of the product owner. |
| ProductOwner_FirstName | String | False |
The First Name of the product owner. |
| ProductOwner_LastName | String | False |
The Last Name of the product owner. |
| ProductName | String | False |
The name of the product. |
| ProductCode | String | False |
The code of the product. |
| VendorName_Id | String | False |
The Id of the vendor of the product.. |
| ProductActive | Bool | False |
Whether this product is active or not. |
| Manufacturer | String | False |
The manufacturer of the product. |
| ProductCategory | String | False |
The category of the product. |
| SalesStartDate | Date | False |
The start date of the sale of the product. |
| SalesEndDate | Date | False |
The end date of the sale of the product. |
| SupportStartDate | Date | False |
The start date of the support of the product. |
| SupportEndDate | Date | False |
The end date of the support of the product. |
| CreatedBy_Id | String | False |
The Id of the User who created the record. |
| ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
| ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
| ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
| CreatedTime | Datetime | False |
The time when the record was created. |
| ModifiedTime | Datetime | False |
The time when the record was modified. |
| Tag | String | False |
A list of tags related to the product. |
| UnitPrice | Double | False |
The unit price of the product. |
| CommissionRate | Double | False |
The commission rate of the product. |
| Tax | String | False |
A json aggregate of the tax related to this product. |
| Taxable | Bool | False |
Whether this product is taxable or not. |
| UsageUnit | String | False |
The unit of usage of the product. |
| QtyOrdered | String | False |
The quantity ordered for this product. |
| QuantityinStock | String | False |
The number of items in stock for this product. |
| ReorderLevel | String | False |
The level of reorder for the product. |
| Handler_Id | String | False |
The Id of the handler of the product. |
| QuantityinDemand | String | False |
The quantity in demand of the product. |
| Description | String | False |
A brief description of 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 |
| Word | String |
Used to search for a specific word in records. |
| DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
| Converted | Boolean |
Set to true to return only converted records. |
| Approved | Boolean |
Set to true to return only approved records. |
| CustomViewId | String |
The custom view Id to be used for filtering this record. |