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.
Search
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 toUS, the store’s country. Any other country is rejected with422 REGION_UNSUPPORTED.
include: even include: {} returns 422 VALIDATION_ERROR on payload.include before credits are held.
Response example
Result fields
site,queryandcountryecho the request.returnedCountis the number of entries inproducts.- Each product includes
rank,productId,titleandurl.productIdis the store’s own product ID.rankfollows the store’s default order, and listings the store marks as sponsored are left out. price,rating,reviewCount,imageUrlandbrandappear when the results page shows them.priceis a number in the product’scurrency(ISO 4217); when sizes are priced apart, it is the lowest one.ratinguses 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}. Producturlvalues 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 toUS, the page’s country. Any other country is rejected with422 REGION_UNSUPPORTED.
include: even include: {} returns 422 VALIDATION_ERROR on payload.include before credits are held.
Response example
Result fields
site,country,urlandproductIdidentify the page.urlis the page that was read, andproductIdmatches the one a search returns.titleis always present.brand,price,listPrice,currency,rating,reviewCount,imagesanddescriptionappear when the page shows them.priceis what a shopper pays as the page first shows it, before coupons and delivery, incurrency(ISO 4217).listPriceis the regular price the page strikes through, present when it is aboveprice.ratinguses a five-point scale with two decimals.reviewCountis the number of reviews.imageslists up to 30 photos from the product’s gallery, in page order. Sephora returns up to two photos.descriptionis 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 withENGINE_NO_RESULT. - Only completed tasks are charged: 0.5 credits for a search or a product page.