/nykaa/brands/products

POST /api/nykaa/brands/products

Price: 20 credits

List the products of a Nykaa brand with category, price band, discount, rating and attribute filters: name, MRP and selling price, discount, rating, shades or sizes, stock and offers

How to use it

Brand ids are the brand_ids of nykaa/products/search results and the number after /c/ in Nykaa brand URLs. Pass a returned id to nykaa/products for shades and details or to nykaa/products/reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• brand_ids array — Nykaa brand ids to keep (default: []; examples: ["596","604"])
• category_ids array — Nykaa category ids to keep (default: []; examples: ["249"])
• price_ranges array — Price bands in INR to keep (default: []; one of: "below_500", "500_999", "1000_1999", "2000_3999", "above_4000")
• min_discount integer nullable — Lowest discount in percent, in steps of 10 (min: 10; max: 70)
• min_rating integer nullable — Lowest average rating in stars (min: 1; max: 4)
• filters array — Further Nykaa filters as filter key and option id (default: []; examples: ["color_filter:15514","finish_filter:10881"])
• count integer required — Max number of results (min: 1; max: 2000)
• brand string required — Nykaa brand id or brand URL (examples: "596", "https://www.nykaa.com/brands/maybelline-new-york/c/596")
• sort string — Result order (default: "popularity"; one of: "popularity", "newest", "price_low", "price_high", "discount", "rating", "name")

Response

• @type string (default: "NykaaProductCard")
• id string required
• parent_id string nullable
• url string nullable
• name string nullable
• brand string nullable
• brand_ids array (default: [])
• sku string nullable
• parent_sku string nullable
• image string nullable
• images array (default: [])
• currency string (default: "INR")
• mrp number nullable
• price number nullable
• discount_percent number nullable
• rating number nullable
• rating_count integer nullable
• configuration_type string nullable
• option_type string nullable
• option_count integer nullable
• pack_size string nullable
• seller_name string nullable
• vendor_id string nullable
• vendor_sku string nullable
• stock_quantity integer nullable
• min_order_quantity integer nullable
• max_order_quantity integer nullable
• categories array (default: [])
  • @type string (default: "NykaaCategoryRef")
  • id string nullable
  • name string nullable
• category_ids array (default: [])
• offers array (default: [])
  • @type string (default: "NykaaOffer")
  • id string nullable
  • description string nullable
• offer_count integer nullable
• tags array (default: [])
• is_in_stock boolean nullable
• is_returnable boolean nullable
• is_luxe boolean nullable
• is_sponsored boolean 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 — Nykaa has no brand under that id or rejected the filters 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 — Something broke on our side 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.