Catalog - Keystone Commerce API Docs

Catalog endpoints use your Partner API key to determine which catalog to return. Response examples show sample values: IDs, slugs and totals in your catalog differ, so use the values your own requests return.

x-api-key: <api_key>

Method	Endpoint	Auth
`GET`	`/categories`	Partner API key

Request:

curl https://dev-api.keystonecommerce.in/api/v1/categories \
  -H "x-api-key: <api_key>"

Response:

{
  "statusCode": 200,
  "message": "Success",
  "data": [
    {
      "id": "cat_cat01",
      "name": "Vehicle Electronics",
      "slug": "vehicle-electronics",
      "parentId": null,
      "children": [
        {
          "id": "cat_sub0101",
          "name": "Stereos & Head Units",
          "slug": "sub0101-stereos-head-units",
          "parentId": "cat_cat01"
        },
        {
          "id": "cat_sub0102",
          "name": "Cameras (Dash & Reverse)",
          "slug": "sub0102-cameras-dash-reverse",
          "parentId": "cat_cat01"
        }
      ]
    }
  ]
}

List products

Method	Endpoint	Auth
`GET`	`/products`	Partner API key

Query parameters:

Param	Type	Required	Notes
`page`	number	No	Default `1`
`limit`	number	No	Default `20`, max `100`
`search`	string	No	Matches product name or brand
`categoryId`	string	No	Includes products in descendant categories
`brand`	string	No	Case-insensitive; matches any part of the brand name
`sortBy`	`createdAt`, `updatedAt`, `name`, `brand`, `sku`	No	Default `createdAt`
`sortOrder`	`asc`, `desc`	No	Default `desc`

Request:

curl "https://dev-api.keystonecommerce.in/api/v1/products?page=1&limit=2&sortBy=name&sortOrder=asc" \
  -H "x-api-key: <api_key>"

Response:

{
  "statusCode": 200,
  "message": "Success",
  "data": [
    {
      "id": "prod_key064",
      "name": "10W IPX5 Portable Bluetooth Speaker - 12-Hour Battery",
      "slug": "10w-ipx5-portable-bluetooth-speaker-12-hour-battery-key064",
      "brand": "keystone",
      "sku": "KEY064",
      "categoryId": "cat_sub0802",
      "sellingPrice": "1019",
      "mrp": "1199",
      "stock": 100,
      "images": [
        "https://storage.googleapis.com/keystone-media-dev/products/prod_key064/01-screenshot_2026-05-04_at_6.45.42_pm.png"
      ],
      "isActive": true
    }
  ],
  "meta": {
    "total": 58,
    "page": 1,
    "limit": 2,
    "totalPages": 29
  }
}

brand is null for products without a brand.

Retrieve product

Method	Endpoint	Auth
`GET`	`/products/{slug}`	Partner API key

Request:

curl https://dev-api.keystonecommerce.in/api/v1/products/<product_slug> \
  -H "x-api-key: <api_key>"

Response:

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": "prod_key064",
    "name": "10W IPX5 Portable Bluetooth Speaker - 12-Hour Battery",
    "slug": "10w-ipx5-portable-bluetooth-speaker-12-hour-battery-key064",
    "brand": "keystone",
    "sku": "KEY064",
    "categoryId": "cat_sub0802",
    "sellingPrice": "1019",
    "mrp": "1199",
    "stock": 100,
    "images": [
      "https://storage.googleapis.com/keystone-media-dev/products/prod_key064/01-screenshot_2026-05-04_at_6.45.42_pm.png"
    ],
    "isActive": true
  }
}

Search catalog

Method	Endpoint	Auth
`GET`	`/search`	Partner API key

Query parameters:

Param	Type	Required	Notes
`q`	string	Yes	Search term
`type`	`products`, `categories`, `all`	No	Default `all`
`limit`	number	No	Default `20`, max `50`
`source`	string	No	Optional analytics source, for example `web`, `app`, or `docs`

Request:

curl "https://dev-api.keystonecommerce.in/api/v1/search?q=stereo&type=all&limit=2&source=web" \
  -H "x-api-key: <api_key>"

Response:

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "products": [
      {
        "id": "prod_key001",
        "slug": "7-inch-android-car-stereo-with-bluetooth-key001",
        "name": "7-Inch Android Car Stereo with Bluetooth",
        "brand": "keystone",
        "sellingPrice": "3306.00",
        "images": [
          "https://storage.googleapis.com/keystone-media-dev/products/prod_key001/01-screenshot_2026-04-27_at_3.35.39_pm.png"
        ],
        "categoryId": "cat_sub0101",
        "score": 1
      }
    ],
    "categories": [
      {
        "id": "cat_sub0101",
        "slug": "sub0101-stereos-head-units",
        "name": "Stereos & Head Units",
        "image": null,
        "score": 0.85714287
      }
    ],
    "totalResults": 2,
    "topScore": 1
  }
}

Calculate exchange quote

Calculate a product’s exchange value from its configured trade-in selections. Available fields and values vary by product. Available only for products with tradeInEnabled: true in the product response. The six-digit pincode must be enabled for trade-in collection.

Method	Endpoint	Auth
`POST`	`/products/{productId}/exchange-quote`	Partner API key

Request:

curl -X POST https://dev-api.keystonecommerce.in/api/v1/products/<product_id>/exchange-quote \
  -H "x-api-key: <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "pincode": "560001",
    "selection": {
      "capacity": "9ah",
      "condition": "good"
    }
  }'

Response:

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "value": "450.00",
    "selection": {
      "capacity": "9ah",
      "condition": "good"
    }
  }
}

​List categories

​List products

​Retrieve product

​Search catalog

​Calculate exchange quote

List categories

List products

Retrieve product

Search catalog

Calculate exchange quote