/sephora/products

POST /api/sephora/products

Price: 20 credits

Get a Sephora product: brand, description, usage, rating, every shade or size with price, stock and ingredients, category path, review highlights and videos

How to use it

Fetch one Sephora product by the P-prefixed id or its URL. Pass sku_id to get a specific shade or size as sku; skus lists all of them either way.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Sephora product id or URL (examples: "P524970", "https://www.sephora.com/product/pocket-bronze-long-wearing-cream-bronzer-P524970"; minLength: 1)
• sku_id string nullable — Shade or size id to return as sku; the product's default when omitted (examples: "2981074")

Response

• @type string (default: "SephoraProduct")
• id string required
• url string nullable
• alias string nullable
• name string nullable
• brand object nullable
  • @type string (default: "SephoraBrandRef")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • description string nullable
• description string nullable
• short_description string nullable
• quick_description string nullable
• usage string nullable
• rating number nullable
• review_count integer nullable
• loves_count integer nullable
• variation_type string nullable
• categories array (default: [])
  • @type string (default: "SephoraCategoryRef")
  • id string required
  • name string nullable
  • url string nullable
• collections array (default: [])
• sku object nullable
  • @type string (default: "SephoraSku")
  • id string required
  • url string nullable
  • variation_type string nullable
  • variation_value string nullable
  • variation_description string nullable
  • size string nullable
  • swatch_label string nullable
  • price number nullable
  • price_max number nullable
  • sale_price number nullable
  • value_price number nullable
  • currency string nullable
  • image string nullable
  • images array (default: [])
  • swatch string nullable
  • badge string nullable
  • highlights array (default: [])
  • attributes array (default: [])
    • @type string (default: "SephoraAttribute")
    • name string required
    • values array (default: [])
  • ingredients string nullable
  • disclosures string nullable
  • beauty_insider_level string nullable
  • max_purchase_quantity integer nullable
  • replenishment_discount_percent number nullable
  • replenishment_price number nullable
  • replenishment_frequency integer nullable
  • replenishment_frequency_unit string nullable
  • free_shipping_type string nullable
  • is_out_of_stock boolean nullable
  • is_only_few_left boolean nullable
  • is_new boolean nullable
  • is_limited_edition boolean nullable
  • is_limited_time_offer boolean nullable
  • is_online_only boolean nullable
  • is_sephora_exclusive boolean nullable
  • is_app_exclusive boolean nullable
  • is_first_access boolean nullable
  • is_beauty_insider_only boolean nullable
  • is_beauty_insider_reward boolean nullable
  • is_free boolean nullable
  • is_free_shipping boolean nullable
  • is_returnable boolean nullable
  • is_pickup_eligible boolean nullable
  • is_reserve_in_store_eligible boolean nullable
  • is_same_day_eligible boolean nullable
  • is_replenishment_eligible boolean nullable
  • is_coming_soon boolean nullable
  • is_store_only boolean nullable
  • is_with_back_in_stock_treatment boolean nullable
• skus array (default: [])
  • @type string (default: "SephoraSku")
  • id string required
  • url string nullable
  • variation_type string nullable
  • variation_value string nullable
  • variation_description string nullable
  • size string nullable
  • swatch_label string nullable
  • price number nullable
  • price_max number nullable
  • sale_price number nullable
  • value_price number nullable
  • currency string nullable
  • image string nullable
  • images array (default: [])
  • swatch string nullable
  • badge string nullable
  • highlights array (default: [])
  • attributes array (default: [])
    • @type string (default: "SephoraAttribute")
    • name string required
    • values array (default: [])
  • ingredients string nullable
  • disclosures string nullable
  • beauty_insider_level string nullable
  • max_purchase_quantity integer nullable
  • replenishment_discount_percent number nullable
  • replenishment_price number nullable
  • replenishment_frequency integer nullable
  • replenishment_frequency_unit string nullable
  • free_shipping_type string nullable
  • is_out_of_stock boolean nullable
  • is_only_few_left boolean nullable
  • is_new boolean nullable
  • is_limited_edition boolean nullable
  • is_limited_time_offer boolean nullable
  • is_online_only boolean nullable
  • is_sephora_exclusive boolean nullable
  • is_app_exclusive boolean nullable
  • is_first_access boolean nullable
  • is_beauty_insider_only boolean nullable
  • is_beauty_insider_reward boolean nullable
  • is_free boolean nullable
  • is_free_shipping boolean nullable
  • is_returnable boolean nullable
  • is_pickup_eligible boolean nullable
  • is_reserve_in_store_eligible boolean nullable
  • is_same_day_eligible boolean nullable
  • is_replenishment_eligible boolean nullable
  • is_coming_soon boolean nullable
  • is_store_only boolean nullable
  • is_with_back_in_stock_treatment boolean nullable
• use_it_with array (default: [])
  • @type string (default: "SephoraRelatedSku")
  • id string required
  • product_id string nullable
  • name string nullable
  • brand_name string nullable
  • url string nullable
  • size string nullable
  • variation_value string nullable
  • price number nullable
  • currency string nullable
  • image string nullable
  • is_out_of_stock boolean nullable
  • is_going_fast boolean nullable
  • is_limited_quantity boolean nullable
• videos array (default: [])
  • @type string (default: "SephoraVideo")
  • id string required
  • url string nullable
  • image string nullable
• review_images array (default: [])
  • @type string (default: "SephoraReviewImage")
  • id string required
  • review_id string nullable
  • image string nullable
  • is_incentivized boolean nullable
• review_summary string nullable
• review_sentiments array (default: [])
  • @type string (default: "SephoraSentiment")
  • name string required
  • polarity string nullable
  • mention_count integer nullable
• questions array (default: [])
  • @type string (default: "SephoraQuestion")
  • text string required
  • author string nullable
  • created_at integer nullable
  • answer_count integer nullable
  • answer string nullable
  • answer_author string nullable
  • answer_created_at integer nullable
  • answer_helpful_count integer nullable
• related_searches array (default: [])
  • @type string (default: "SephoraLink")
  • name string required
  • url 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 — No Sephora product has this id, or the sku_id belongs to another product. 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.