/nykaa/products

POST /api/nykaa/products

Price: 20 credits

Get a Nykaa product by id or URL: brand, categories, MRP and selling price, shades or sizes with stock, attributes, description, how to use, ingredients, manufacturer details, offers, rating breakdown, review summary and latest reviews

How to use it

Find product ids with nykaa/products/search, nykaa/categories/products or nykaa/brands/products. The full review list is nykaa/products/reviews with the same id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Nykaa product id or product URL (examples: "353926", "https://www.nykaa.com/maybelline-new-york-color-sensational-creamy-matte-lipsticks/p/353926")

Response

• @type string (default: "NykaaProduct")
• 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
• ean string nullable
• product_type string nullable
• configuration_type string nullable
• vendor_id string nullable
• vendor_sku string nullable
• image string nullable
• images array (default: [])
• videos array (default: [])
  • @type string (default: "NykaaVideo")
  • url string nullable
  • stream_url string nullable
  • thumbnail string nullable
  • duration_seconds number nullable
• currency string (default: "INR")
• mrp number nullable
• price number nullable
• discount_percent number nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• rating_breakdown object (default: {})
  • * integer
• review_summary string nullable
• review_keywords array (default: [])
  • @type string (default: "NykaaKeyword")
  • text string nullable
  • sentiment string nullable
• latest_reviews array (default: [])
  • @type string (default: "NykaaReview")
  • id string nullable
  • product_id string nullable
  • option_id string nullable
  • text string nullable
  • rating integer nullable
  • created_at integer nullable
  • like_count integer nullable
  • author string nullable
  • author_id string nullable
  • author_image string nullable
  • author_review_count integer nullable
  • author_image_count integer nullable
  • label string nullable
  • is_verified_buyer boolean nullable
  • is_pro_user boolean nullable
  • author_traits array (default: [])
    • @type string (default: "NykaaReviewerTrait")
    • kind string nullable
    • name string nullable
    • values array (default: [])
  • images array (default: [])
  • tags array (default: [])
• question_count integer nullable
• categories array (default: [])
  • @type string (default: "NykaaCategoryRef")
  • id string nullable
  • name string nullable
• category_ids array (default: [])
• option_type string nullable
• option_count integer nullable
• options array (default: [])
  • @type string (default: "NykaaOption")
  • id string nullable
  • name string nullable
  • sku string nullable
  • url string nullable
  • image string nullable
  • shade_image string nullable
  • mrp number nullable
  • price number nullable
  • discount_percent number nullable
  • stock_quantity integer nullable
  • pack_size string nullable
  • expiry_date integer nullable
  • is_in_stock boolean nullable
  • is_bestseller boolean nullable
  • tags array (default: [])
• attributes array (default: [])
  • @type string (default: "NykaaAttribute")
  • name string nullable
  • value string nullable
• description string nullable
• how_to_use string nullable
• ingredients string nullable
• country_of_origin string nullable
• country_of_origin_code string nullable
• parties array (default: [])
  • @type string (default: "NykaaParty")
  • role string nullable
  • name string nullable
  • address string nullable
• seller_name string nullable
• expiry_date integer nullable
• pack_size string nullable
• stock_quantity integer nullable
• min_order_quantity integer nullable
• max_order_quantity integer nullable
• offers array (default: [])
  • @type string (default: "NykaaOffer")
  • id string nullable
  • description string nullable
• bestseller_label string nullable
• tags array (default: [])
• return_period_days integer nullable
• return_policy string nullable
• is_returnable boolean nullable
• is_in_stock boolean nullable
• is_luxe boolean nullable
• seo_title string nullable
• seo_description string 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 product under that id 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.