/nykaafashion/brands/products

POST /api/nykaafashion/brands/products

Price: 10 credits

List the products of a Nykaa Fashion brand with category, size, colour, price, discount, launch date and attribute filters: name, MRP and selling price, discount, sizes, sibling colours, offers, badges and stock

How to use it

Brand ids are the number after /c/ in Nykaa Fashion brand URLs under /designers/ and the brand_id of nykaafashion/products; an unknown id returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• sort string — Result order (default: "popularity"; one of: "popularity", "newest", "price_low", "price_high", "discount", "bestseller", "fastest_shipping")
• brand_ids array — Nykaa Fashion brand ids to keep (default: []; examples: ["7782","57825"])
• category_ids array — Nykaa Fashion category ids to keep (default: []; examples: ["5","4497"])
• size_ids array — Size ids to keep, in stock in that size (default: []; examples: ["18825"])
• color_ids array — Colour ids to keep (default: []; examples: ["67"])
• min_price integer nullable — Lowest selling price in INR (min: 0)
• max_price integer nullable — Highest selling price in INR (min: 0)
• min_discount integer nullable — Lowest discount in percent, in steps of 10 (min: 0; max: 70)
• launched_within_days integer nullable — Keep products launched within this many days (one of: 1, 3, 7, 30)
• filters array — Further Nykaa Fashion filters as filter key and option id (default: []; examples: ["material_filter:161","occasion_filter:175","new_tags_filter:luxe"])
• count integer required — Max number of results (min: 1; max: 2500)
• brand string required — Nykaa Fashion brand id or brand URL (examples: "7782", "https://www.nykaafashion.com/designers/inc-5/c/7782")

Response

• @type string (default: "NykaaFashionProductCard")
• id string required
• sku string nullable
• url string nullable
• name string nullable
• brand string nullable
• image string nullable
• images array (default: [])
• currency string (default: "INR")
• mrp number nullable
• price number nullable
• discount_percent number nullable
• configuration_type string nullable
• category_ids array (default: [])
• sizes array (default: [])
  • @type string (default: "NykaaFashionSize")
  • id string nullable
  • name string nullable
• colours array (default: [])
  • @type string (default: "NykaaFashionColour")
  • id string nullable
  • sku string nullable
  • name string nullable
  • color_code string nullable
  • url string nullable
  • image string nullable
  • is_in_stock boolean nullable
• offers array (default: [])
  • @type string (default: "NykaaFashionOffer")
  • id string nullable
  • description string nullable
  • discount_percent number nullable
  • discount_amount number nullable
  • min_order_value number nullable
  • max_order_value number nullable
  • discount_cap_amount number nullable
  • min_order_quantity integer nullable
  • is_first_order_only boolean nullable
  • offer_tag string nullable
  • starts_at integer nullable
  • ends_at integer nullable
  • updated_at integer nullable
• offer_count integer nullable
• tags array (default: [])
• is_in_stock 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 — 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 — 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.