Search Product | DICE | Documentation

curl -G https://heimdall.eka.io/apis/external/search/searchProduct/ \
     -H "DICE-APP-ID: {{Company Code}}" \
     -H "X-CLIENT-ID: {{API Client ID}}" \
     -H "X-CLIENT-SECRET: {{API Client Secret}}" \
     -d q=pt1

{
  "products": [
    {
      "id": 37338,
      "title": "pt1",
      "description": " ",
      "sku": " ",
      "hsn": "ert",
      "gl": "34567",
      "productId": "7004",
      "service": "Utilities",
      "amount": 30,
      "gst": 0,
      "currency": "INR",
      "addedAt": 1724782787813,
      "updatedAt": 1737638946379,
      "active": true,
      "unit": "piece",
      "config": {
        "qcEnabled": false,
        "skipFAR": false
      }
    },
    {
      "id": 37339,
      "title": "pt1",
      "description": " ",
      "sku": " ",
      "hsn": "ert",
      "gl": "34567",
      "productId": "7004",
      "service": "Utilities",
      "amount": 10000000,
      "gst": 0,
      "currency": "INR",
      "addedAt": 1724825798856,
      "updatedAt": 1726637568806,
      "active": true,
      "unit": "piece",
      "config": {
        "qcEnabled": false,
        "skipFAR": false
      }
    },
    {
      "id": 37340,
      "title": "pt1",
      "description": " ",
      "sku": " ",
      "hsn": "ert",
      "gl": "34567",
      "productId": "7004",
      "service": "Utilities",
      "amount": 250,
      "gst": 0,
      "currency": "INR",
      "addedAt": 1724826237935,
      "updatedAt": 1738831506967,
      "active": true,
      "unit": "piece",
      "config": {
        "qcEnabled": false,
        "skipFAR": false,
        "lastPurchasePrice": 333,
        "vendorName": "tata motors"
      }
    }
  ]
}

Search Product API

This endpoint allows users to search for products based on a query string. It retrieves a list of products that match the specified search criteria.

Request

Method: GET
Endpoint: {{host}}/apis/external/search/searchProduct/
Query Parameters:
- q (string): The search term used to find products. In this example, the query is set to pt1.

Response

The response will be in JSON format and will include an array of products that match the search criteria. Each product object contains the following fields:

id (integer): Unique identifier for the product.
title (string): The name of the product.
description (string): A brief description of the product.
sku (string): Stock Keeping Unit identifier for the product.
hsn (string): Harmonized System Nomenclature code.
gl (string): General Ledger code associated with the product.
productId (string): Identifier for the product in the system.
service (string): Service type related to the product.
amount (number): Price of the product.
gst (number): Goods and Services Tax applicable to the product.
currency (string): Currency code for the price.
addedAt (integer): Timestamp of when the product was added.
updatedAt (integer): Timestamp of the last update to the product.
active (boolean): Indicates if the product is currently active.
unit (string): Measurement unit for the product.
config (object): Configuration settings for the product, including:
- qcEnabled (boolean): Indicates if quality control is enabled.
- skipFAR (boolean): Indicates if FAR checks should be skipped.

Example Response

1 {
2     "products": [
3         {
4             "id": 37338,
5             "title": "pt1",
6             "description": " ",
7             "sku": " ",
8             "hsn": "ert",
9             "gl": "34567",
10             "productId": "7004",
11             "service": "Utilities",
12             "amount": 30,
13             "gst": 0,
14             "currency": "INR",
15             "addedAt": 1724782787813,
16             "updatedAt": 1737638946379,
17             "active": true,
18             "unit": "piece",
19             "config": {
20                 "qcEnabled": false,
21                 "skipFAR": false
22             }
23         },
24         {
25             "id": 37339,
26             "title": "pt1",
27             "description": " ",
28             "sku": " ",
29             "hsn": "ert",
30             "gl": "34567",
31             "productId": "7004",
32             "service": "Utilities",
33             "amount": 10000000,
34             "gst": 0,
35             "currency": "INR",
36             "addedAt": 1724825798856,
37             "updatedAt": 1726637568806,
38             "active": true,
39             "unit": "piece",
40             "config": {
41                 "qcEnabled": false,
42                 "skipFAR": false
43             }
44         },
45         {
46             "id": 37340,
47             "title": "pt1",
48             "description": " ",
49             "sku": " ",
50             "hsn": "ert",
51             "gl": "34567",
52             "productId": "7004",
53             "service": "Utilities",
54             "amount": 250,
55             "gst": 0,
56             "currency": "INR",
57             "addedAt": 1724826237935,
58             "updatedAt": 1738831506967,
59             "active": true,
60             "unit": "piece",
61             "config": {
62                 "vendorName": "tata motors",
63                 "lastPurchasePrice": 333,
64                 "qcEnabled": false,
65                 "skipFAR": false
66             }
67         }
68     ]
69 }

## Search Product API This endpoint allows users to search for products based on a query string. It retrieves a list of products that match the specified search criteria. ### Request - **Method**: `GET` - **Endpoint**: `{{host}}/apis/external/search/searchProduct/` - **Query Parameters**: - `q` (string): The search term used to find products. In this example, the query is set to `pt1`. ### Response The response will be in JSON format and will include an array of products that match the search criteria. Each product object contains the following fields: - `id` (integer): Unique identifier for the product. - `title` (string): The name of the product. - `description` (string): A brief description of the product. - `sku` (string): Stock Keeping Unit identifier for the product. - `hsn` (string): Harmonized System Nomenclature code. - `gl` (string): General Ledger code associated with the product. - `productId` (string): Identifier for the product in the system. - `service` (string): Service type related to the product. - `amount` (number): Price of the product. - `gst` (number): Goods and Services Tax applicable to the product. - `currency` (string): Currency code for the price. - `addedAt` (integer): Timestamp of when the product was added. - `updatedAt` (integer): Timestamp of the last update to the product. - `active` (boolean): Indicates if the product is currently active. - `unit` (string): Measurement unit for the product. - `config` (object): Configuration settings for the product, including: - `qcEnabled` (boolean): Indicates if quality control is enabled. - `skipFAR` (boolean): Indicates if FAR checks should be skipped. ### Example Response ``` json { "products": [ { "id": 37338, "title": "pt1", "description": " ", "sku": " ", "hsn": "ert", "gl": "34567", "productId": "7004", "service": "Utilities", "amount": 30, "gst": 0, "currency": "INR", "addedAt": 1724782787813, "updatedAt": 1737638946379, "active": true, "unit": "piece", "config": { "qcEnabled": false, "skipFAR": false } }, { "id": 37339, "title": "pt1", "description": " ", "sku": " ", "hsn": "ert", "gl": "34567", "productId": "7004", "service": "Utilities", "amount": 10000000, "gst": 0, "currency": "INR", "addedAt": 1724825798856, "updatedAt": 1726637568806, "active": true, "unit": "piece", "config": { "qcEnabled": false, "skipFAR": false } }, { "id": 37340, "title": "pt1", "description": " ", "sku": " ", "hsn": "ert", "gl": "34567", "productId": "7004", "service": "Utilities", "amount": 250, "gst": 0, "currency": "INR", "addedAt": 1724826237935, "updatedAt": 1738831506967, "active": true, "unit": "piece", "config": { "vendorName": "tata motors", "lastPurchasePrice": 333, "qcEnabled": false, "skipFAR": false } } ] } ```

Query parameters

qstringOptional

Fetches Product whose names match the given q parameter using a case-insensitive partial match.

Response headers

request-idstringOptional

Response

productslist of objects

Search Product API

This endpoint allows users to search for products based on a query string. It retrieves a list of products that match the specified search criteria.

Request

Method: GET

Endpoint: {{host}}/apis/external/search/searchProduct/

Query Parameters:

q (string): The search term used to find products. In this example, the query is set to pt1.

Response

The response will be in JSON format and will include an array of products that match the search criteria. Each product object contains the following fields:

id (integer): Unique identifier for the product.

title (string): The name of the product.

description (string): A brief description of the product.

sku (string): Stock Keeping Unit identifier for the product.

hsn (string): Harmonized System Nomenclature code.

gl (string): General Ledger code associated with the product.

productId (string): Identifier for the product in the system.

service (string): Service type related to the product.

amount (number): Price of the product.

gst (number): Goods and Services Tax applicable to the product.

currency (string): Currency code for the price.

addedAt (integer): Timestamp of when the product was added.

updatedAt (integer): Timestamp of the last update to the product.

active (boolean): Indicates if the product is currently active.

unit (string): Measurement unit for the product.

config (object): Configuration settings for the product, including:

qcEnabled (boolean): Indicates if quality control is enabled.
skipFAR (boolean): Indicates if FAR checks should be skipped.

Example Response

1 {
2     "products": [
3         {
4             "id": 37338,
5             "title": "pt1",
6             "description": " ",
7             "sku": " ",
8             "hsn": "ert",
9             "gl": "34567",
10             "productId": "7004",
11             "service": "Utilities",
12             "amount": 30,
13             "gst": 0,
14             "currency": "INR",
15             "addedAt": 1724782787813,
16             "updatedAt": 1737638946379,
17             "active": true,
18             "unit": "piece",
19             "config": {
20                 "qcEnabled": false,
21                 "skipFAR": false
22             }
23         },
24         {
25             "id": 37339,
26             "title": "pt1",
27             "description": " ",
28             "sku": " ",
29             "hsn": "ert",
30             "gl": "34567",
31             "productId": "7004",
32             "service": "Utilities",
33             "amount": 10000000,
34             "gst": 0,
35             "currency": "INR",
36             "addedAt": 1724825798856,
37             "updatedAt": 1726637568806,
38             "active": true,
39             "unit": "piece",
40             "config": {
41                 "qcEnabled": false,
42                 "skipFAR": false
43             }
44         },
45         {
46             "id": 37340,
47             "title": "pt1",
48             "description": " ",
49             "sku": " ",
50             "hsn": "ert",
51             "gl": "34567",
52             "productId": "7004",
53             "service": "Utilities",
54             "amount": 250,
55             "gst": 0,
56             "currency": "INR",
57             "addedAt": 1724826237935,
58             "updatedAt": 1738831506967,
59             "active": true,
60             "unit": "piece",
61             "config": {
62                 "vendorName": "tata motors",
63                 "lastPurchasePrice": 333,
64                 "qcEnabled": false,
65                 "skipFAR": false
66             }
67         }
68     ]
69 }

1	{
2	"products": [
3	{
4	"id": 37338,
5	"title": "pt1",
6	"description": " ",
7	"sku": " ",
8	"hsn": "ert",
9	"gl": "34567",
10	"productId": "7004",
11	"service": "Utilities",
12	"amount": 30,
13	"gst": 0,
14	"currency": "INR",
15	"addedAt": 1724782787813,
16	"updatedAt": 1737638946379,
17	"active": true,
18	"unit": "piece",
19	"config": {
20	"qcEnabled": false,
21	"skipFAR": false
22	}
23	},
24	{
25	"id": 37339,
26	"title": "pt1",
27	"description": " ",
28	"sku": " ",
29	"hsn": "ert",
30	"gl": "34567",
31	"productId": "7004",
32	"service": "Utilities",
33	"amount": 10000000,
34	"gst": 0,
35	"currency": "INR",
36	"addedAt": 1724825798856,
37	"updatedAt": 1726637568806,
38	"active": true,
39	"unit": "piece",
40	"config": {
41	"qcEnabled": false,
42	"skipFAR": false
43	}
44	},
45	{
46	"id": 37340,
47	"title": "pt1",
48	"description": " ",
49	"sku": " ",
50	"hsn": "ert",
51	"gl": "34567",
52	"productId": "7004",
53	"service": "Utilities",
54	"amount": 250,
55	"gst": 0,
56	"currency": "INR",
57	"addedAt": 1724826237935,
58	"updatedAt": 1738831506967,
59	"active": true,
60	"unit": "piece",
61	"config": {
62	"vendorName": "tata motors",
63	"lastPurchasePrice": 333,
64	"qcEnabled": false,
65	"skipFAR": false
66	}
67	}
68	]
69	}

Search Product API

Request

Response

Example Response

Headers

Query parameters

Response headers

Response

Search Product API

Request

Response

Example Response