/ajio/products/search

POST /api/ajio/products/search

Price: 20 credits

Search AJIO products by text with gender, brand, category, price band, discount, rating and facet filters: name, brand, selling price, MRP and coupon price, discount, rating, category and tags

How to use it

Pass a returned id to ajio/products for sizes, stock, offers and ratings. Category names for the categories filter look like 'Men - Jeans'.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• gender array — Gender sections to keep (default: []; one of: "men", "women")
• brands array — Brand names to keep (default: []; examples: ["LEVI'S","Pepe Jeans"])
• categories array — AJIO category names to keep (default: []; examples: ["Men - Jeans","Women - Tops"])
• price_ranges array — Price bands in INR to keep (default: []; one of: "below_500", "500_1000", "1001_1500", "1501_2000", "2001_2500", "2501_5000", "above_5000")
• min_discount integer nullable — Lowest discount in percent, in steps of 10 (min: 10; max: 90)
• min_rating integer nullable — Lowest average rating in stars (min: 1; max: 4)
• facets array — Further AJIO filter facets as facet code and value (default: []; examples: ["brickfittype:Slim Fit","verticalfabrictype:Cotton"])
• sort string — Result order (default: "relevance"; one of: "relevance", "newest", "price_low", "price_high", "discount", "rating")
• count integer required — Max number of results (min: 1; max: 2000)
• query string required — Search text (examples: "jeans", "white sneakers"; minLength: 1)

Response

• @type string (default: "AjioProductCard")
• id string required
• sku string nullable
• url string nullable
• name string nullable
• brand string nullable
• brand_code string nullable
• image string nullable
• images array (default: [])
• currency string nullable
• price number nullable
• mrp number nullable
• offer_price number nullable
• discount_percent integer nullable
• rating number nullable
• rating_count integer nullable
• coupon_status string nullable
• segment string nullable
• segment_code string nullable
• vertical string nullable
• vertical_code string nullable
• category string nullable
• category_code string nullable
• planning_category string nullable
• catalog string nullable
• product_tag string nullable
• tags array (default: [])
  • @type string (default: "AjioTag")
  • kind string nullable
  • name string nullable
  • values array (default: [])
• seller_id string nullable
• seller_sku string nullable
• max_quantity integer nullable
• return_window_days integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — AJIO did not return a usable answer Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.