v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Search Products

Retrieve products available at the current org based on the query params such as SKU, quantity, price, item status, images, attributes and so on.

get/product/search

Query parameters

qstring required

Query string - URL encoded string containing the parameters to be used for searching. Multiple parameters can be passed in the “attribute:OPERATOR:value” with fixed operators and separated by '|' character. <br>To search for a product of color black or blue or green, size XL, price between 2000 & 4000 and department Men's, the search query would like -<br>q=(color:IN:Black;Blue;Green|size:EQUALS:XL|price:RANGE:2000;4000|department:EQUALS:Men) <br>Urlencoded string = color%3AIN%3ABlack%3BBlue%3BGreen%7Csize%3AEQUALS%3AXL%7Cprice%3ARANGE%3A2000%3B4000%7Cdepartment%3AEQUALS%3AMen

format'xml' | 'json'

Preferred response format.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "SUCCESS"
    },
    "product": {
      "count": 21,
      "rows": 10,
      "results": {
        "item": [
          {
            "id": "26666454",
            "price": 1000,
            "org_id": 50074,
            "description": "soap",
            "sku": "item-001",
            "added_on": "2017-06-20T00:00:00Z",
            "img_url": "https://nightly.capillary.in/productManagement/Colors/img3.jpg",
            "ean": "401234567892"
          }
        ]
      }
    }
  }
}