View Merchandised Product Slots in API Response

Discovery Search and Category API allows you to fetch the merchandising product grid details directly through the API. The feature exposes Product Slot data in the response. Note that "Product Slots" here are the products locked through a Slot-based merchandising rule. When you lock a product at a slot, you will see that slot in the response.

To view the slot information, pass the following URL debug parameter in the Search and Category API request:

merchandising_rules.debug=product_slot

Here is a sample response for slot information returned in the "debug" component:

{
...
  "debug": {
    "merchandising": {
      "products_locked": [
        {
          "product_id": "14715",
          "slot": 4
        },
        {
          "product_id": "97862",
          "slot": 7
        },
        {
          "product_id": "19791",
          "slot": 10
        }
      ]
    }
  }
}

📘

If you want to debug the default product ranking and view the product position of each PID, follow the Ranking Diagnostics on the API guide.