Skip to main content
Search Sephora (sephora.com) and read its product pages through the async task API. Send COMMERCE_SERP with site sephora to get the products a search shows, in the store’s order, or COMMERCE_PRODUCT with a product’s url to read that product. A completed search or product page costs 0.5 credits.
Submit the task, then poll GET /v1/async/task/{id} or receive its webhook. See Async tasks.

Parameters

  • site: Required. sephora.
  • query: Required. The search query, 1-500 characters.
  • limit: Optional integer from 1 to 40, default 20.
  • country: Optional. Defaults to US, the store’s country. Any other country is rejected with 422 REGION_UNSUPPORTED.
Only the payload fields listed above are accepted. Omit include: even include: {} returns 422 VALIDATION_ERROR on payload.include before credits are held.

Response example

Result fields

  • site, query and country echo the request. returnedCount is the number of entries in products.
  • Each product includes rank, productId, title and url. productId is the store’s own product ID. rank follows the store’s default order, and listings the store marks as sponsored are left out.
  • price, rating, reviewCount, imageUrl and brand appear when the results page shows them. price is a number in the product’s currency (ISO 4217); when sizes are priced apart, it is the lowest one.
  • rating uses a five-point scale. Abbreviated review counts such as 999+ are left out.
  • Each search returns products from the store’s first results page.

Product page

Parameters

  • url: Required. A product page on Sephora, up to 2,048 characters: sephora.com/product/{name}-P{id}. Product url values from a search work as they are. Parameters the result does not depend on, such as tracking codes, are dropped before the page is read.
  • country: Optional. Defaults to US, the page’s country. Any other country is rejected with 422 REGION_UNSUPPORTED.
Only the payload fields listed above are accepted. Omit include: even include: {} returns 422 VALIDATION_ERROR on payload.include before credits are held.

Response example

Result fields

  • site, country, url and productId identify the page. url is the page that was read, and productId matches the one a search returns.
  • title is always present. brand, price, listPrice, currency, rating, reviewCount, images and description appear when the page shows them.
  • price is what a shopper pays as the page first shows it, before coupons and delivery, in currency (ISO 4217). listPrice is the regular price the page strikes through, present when it is above price.
  • rating uses a five-point scale with two decimals. reviewCount is the number of reviews.
  • images lists up to 30 photos from the product’s gallery, in page order. Sephora returns up to two photos.
  • description is plain text with one line per paragraph, up to 10,000 characters; text that appears only inside images is not included.

Errors and billing

  • A search that returns no products ends as a failed task.
  • A product page the store answers with 404 or 410, such as a removed product, ends the task with PAGE_UNAVAILABLE, and the message carries the store’s answer. When the store refuses the read with 403, 412, 429 or 435, the task waits and asks again for up to 6 minutes. Other failed reads, and a refusal that lasts longer, end with ENGINE_NO_RESULT.
  • Only completed tasks are charged: 0.5 credits for a search or a product page.