Qodex.ai

Products Search API

GET {{baseUrl}}/api/v1/products/search

This API searches for products in your help desk. The values can be given comma separated, which denotes the search on the field is done using either of the values given.
Zoho Desk APIs support two types of search:exact match and wildcard match.
exact match returns resources only if the value passed exactly matches with a resource in the help desk.
wildcard match returns resources even if the value passed partially matches with a resource in the help desk.
To perform wildcard match, append an asterisk (*) after the value to search.

OAuth Scope

  • Desk.search.READ
  • Desk.products.READ
  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringFrom index, starts from 0
limitstringNo. of entities to fetch
departmentIdstringID of the department from which the entity must be fetched if not passed then searches in permitted departments <br>exact match<br>
idstringID of the Product <br>exact match<br>
productNamestringName of the Product <br>wildcard search<br>
productCodestringCode of the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
contactIdstringID of the contact associated with the product <br>exact match<br>
accountIdstringID of the account associated with the product <br>exact match<br>
_allstringSearch throughout the product <br>wildcard search<br>
customField1stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField2stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField3stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField4stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField5stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField6stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField7stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField8stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField9stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField10stringCustom field in the product <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
createdTimeRangestringKey that filters products created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z
modifiedTimeRangestringKey that filters products modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z
sortBystringSortBy can be: <br>relevance,<br> <br>modifiedTime,<br> <br>createdTime,<br> <br>productName<br>

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;modifiedTime&quot;:&quot;2017-11-02T10:31:35.000Z&quot;,&quot;productCode&quot;:&quot;Search2&quot;,&quot;cf&quot;:{&quot;cf_productTagName&quot;:null},&quot;createdBy&quot;:&quot;5000000009116&quot;,&quot;description&quot;:null,&quot;createdTime&quot;:&quot;2017-11-02T10:31:35.000Z&quot;,&quot;modifiedBy&quot;:&quot;5000000009116&quot;,&quot;departmentIds&quot;:[&quot;5000000007235&quot;],&quot;id&quot;:&quot;5000000009882&quot;,&quot;productName&quot;:&quot;Search2&quot;}],&quot;count&quot;:1}