Products
Get details of Products
Select
The add-in will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.
- Id supports the '=' operator.
- FirstChar supports the '=' operator.
- FilterId supports the '=' operator.
- UserId supports the '=' operator.
- GetSummary supports the '=' operator.
- Ids supports the '=,IN' operators.
For example, the following query is processed server side:
SELECT * FROM Products WHERE Id = 14 SELECT * FROM Products WHERE FirstChar = 'c' SELECT * FROM Products WHERE FilterId = 1 SELECT * FROM Products WHERE UserId = 1 SELECT * FROM Products WHERE GetSummary = 1 SELECT * FROM Products WHERE Ids IN (1, 2)
INSERT
Insert can be executed by specifying the Name columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.
INSERT INTO Products (name) VALUES ('tests')
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 Products SET Name = 'test123' WHERE Id = 2495
DELETE
Delete can be executed by specifying the Id in the WHERE Clause.
For example:
DELETE FROM Products WHERE Id = 15
Columns
Name | Type | ReadOnly | Description |
Id | Integer | True |
product Id |
ActiveFlag | Boolean | True |
Whether this product will be made active or not The allowed values are 0, 1. The default value is 1. |
AddTime | Datetime | True |
Add Time |
Category | String | True |
category |
Code | String | False |
Product code. |
CustomeField | String | True |
CustomeField you will get the result of this column only when criteria filter title is used |
Description | String | True |
description |
FilesCount | String | True |
FilesCount |
FirstChar | String | True |
If supplied only Products whose name starts with the specified letter will be returned |
Name | String | False |
Name of the product |
OwnerActiveFlag | Boolean | True |
OwnerActiveFlag |
OwnerEmail | String | True |
OwnerEmail |
OwnerHasPic | Boolean | True |
OwnerHasPic |
OwnerId | Integer | False |
ID of the user who will be marked as the owner of this product |
OwnerName | String | True |
OwnerName |
OwnerPicHash | String | True |
OwnerPicHas |
Ownervalue | Integer | True |
Owner Id |
Prices | String | False |
Object containing price objects |
Selectable | Boolean | False |
Whether this product can be selected in Deals or not The allowed values are 0, 1. The default value is 1. |
Tax | Integer | False |
Tax percentage The default value is 0. |
Type | String | True |
Type you will get the result of this column only when criteria filter title is used |
Unit | String | False |
Unit in which this product is sold |
UpdateTime | Datetime | True |
Update Time |
VisibleTo | String | False |
Visibility of the product The allowed values are 1, 3, 5, 7. |
SummaryTotalCount | String | True |
You will get data of this column when Criterial filter is GetSummary is used |
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 |
UserId | Integer |
User Id |
FilterId | Integer |
Filter Id |
GetSummary | Boolean |
Get SUmmary |
Ids | Integer |
The Ids of the Products that should be returned in the response |