Skip to navigation
Dice Standardized APIs V2 CopySearch

Search Product

View as Markdown

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

{
    "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
            }
        }
    ]
}

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional

Query parameters

qstringOptional

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

Response headers

request-idstringOptional

Response

OK
productslist of objects