/sephora/products/search

POST /api/sephora/products/search

Price: 20 credits

Search Sephora products by keyword, with brand, rating, price, attribute and category filters

How to use it

Search the Sephora catalogue by keyword. Several values in one filter match any of them, and different filters combine. Some keywords, such as a brand name, return that whole brand or category, and a keyword Sephora cannot match still returns its suggested products, so do not read a non-empty result as a match. Pass a returned id to the Sephora product endpoint for shades, sizes, ingredients and description, or to the Sephora reviews endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of products to return (min: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "bestselling", "top_rated", "price_asc", "price_desc", "newest")
• brands array nullable — Brand names from the Sephora brands list; matching is case- and accent-insensitive, and a name not in that list returns a 422 (examples: ["rhode"], ["rhode","Saie"], ["Estée Lauder"])
• min_rating integer nullable — Minimum average star rating (min: 1; max: 4)
• min_price integer nullable — Minimum price in whole USD (min: 0)
• max_price integer nullable — Maximum price in whole USD (>: 0)
• is_on_sale boolean — Only products on sale when true (default: false)
• is_new boolean — Only new products when true (default: false)
• skin_types array nullable — Skin types (one of: "combination", "dry", "normal", "oily", "sensitive")
• skin_concerns array nullable — Skin concerns (one of: "acne_blemishes", "anti_aging", "bumps", "cellulite", "dark_circles", "dark_spots", "dryness", "dullness", "feminine_hygiene", "fine_lines_wrinkles", "loss_of_firmness_elasticity", "menopause", "oiliness", "pores", "pregnancy_support", "puffiness", "redness", "uneven_skin_tone", "uneven_texture")
• ingredient_preferences array nullable — Ingredient preferences (one of: "adaptogens", "aha_glycolic_acid", "alcohol_free", "antioxidants", "ashwaghanda", "benzoyl_peroxide", "biotin", "bond_building", "clean_at_sephora", "collagen", "cruelty_free", "fragrance_free", "hyaluronic_acid", "hydroquinone", "matcha", "medical_grade_silicone", "mineral", "mineral_physical", "multiple_speeds", "naturally_derived", "niacinamide", "non_comedogenic", "oil_free", "organic", "paraben_free", "peptides", "prebiotics_and_probiotics", "reishi_mushroom", "retinoid", "salicylic_acid", "silicone_free", "squalane", "sulfate_free", "sulfur", "turmeric", "vegan", "vitamin_c", "water_resistant", "zinc")
• formulations array nullable — Formulations (one of: "balm", "bar_soap", "cream", "cushion", "gel", "liquid", "loose_powder", "lotion", "mask", "mousse", "oil", "pencil", "pressed_powder", "scrub", "serum", "spray", "stick", "wipes")
• finishes array nullable — Finishes (one of: "creme", "gel", "glitter", "high_shine", "matte", "metallic", "natural", "radiant", "satin", "sheer", "shimmer")
• coverages array nullable — Coverage levels (one of: "full", "light", "medium", "sheer")
• benefits array nullable — Benefits (one of: "blurring", "brightening", "color_correcting", "crease_resistant", "curling", "hardening", "hydrating", "lengthening", "lightweight", "long_wearing", "moisturizing", "oil_controlling", "plumping", "repairing", "strengthening", "transfer_proof", "transfer_resistant", "volumizing", "water_proof")
• color_families array nullable — Color families (one of: "berry", "black", "blue", "brown", "clear", "coral", "gold", "green", "grey", "multi", "nude", "orange", "pink", "purple", "red", "silver", "universal", "white_off_white", "yellow")
• size_types array nullable — Size types (one of: "gift_set", "mini", "refill", "value")
• shopping_preferences array nullable — Shopping preferences (one of: "best_of_allure", "black_owned_brands", "fsa_hsa", "korean_beauty", "makeup_artist_founded", "olive_young_kbeauty_edit", "only_at_sephora", "planet_aware", "samples_available")
• age_ranges array nullable — Age ranges the product targets (one of: "20s", "30s", "40s", "50s")
• hair_concerns array nullable — Hair concerns (one of: "brassiness", "color_fading", "color_safe", "curl_enhancing", "damage_split_ends", "dandruff", "dryness", "flaky_dry_scalp", "frizz", "heat_protection", "hold_style_extending", "oily_scalp", "scalp_build_up", "shine", "straightening_smoothing", "thinning", "uvprorection", "volumizing")
• hair_types array nullable — Hair types (one of: "fine", "medium", "thick")
• hair_textures array nullable — Hair textures (one of: "coily", "curly", "straight", "wavy")
• sun_protections array nullable — SPF levels (one of: "spf_over_thirty", "spf_thirty_and_under", "spf_under_fifteen")
• bristle_types array nullable — Brush bristle types (one of: "natural", "synthetic")
• fragrance_families array nullable — Fragrance families (one of: "floral", "fresh", "warmspicy", "woody_earthy")
• fragrance_types array nullable — Fragrance types (one of: "citrus_woods", "classic_florals", "classic_woods", "cool_spices", "earthy_greens_herbs", "fresh_aquatics", "fresh_citrus_fruits", "fresh_florals", "fresh_solar", "fruity_florals", "powdery_florals", "warm_florals", "warm_sheer", "warm_sweet_gourmands", "warm_woods", "woody_spices")
• volumes array nullable — False lash volume levels (one of: "dramatic", "full", "natural")
• product_types array nullable — Brush, nail and wellness product types (one of: "base_coat", "blush_brush", "bow_brush", "bronzer_brush", "concealer_brush", "contour_brush", "crease_brush", "foundation_brush", "gel", "highlight_brush", "liner_brush", "nail_care", "nail_polish", "nail_sets", "powder_brush", "shadow_brush", "top_coat", "vibrators", "wellness_tools")
• query string required — Search keywords (examples: "bronzer", "vitamin c serum"; minLength: 1)
• category_id string nullable — Category id to search within (examples: "cat140006"; minLength: 1)

Response

• @type string (default: "SephoraListingProduct")
• id string required
• url string nullable
• name string nullable
• brand_name string nullable
• sku_id string nullable
• price number nullable
• price_max number nullable
• sale_price number nullable
• sale_price_max number nullable
• value_price number nullable
• currency string nullable
• sale_status string nullable
• rating number nullable
• review_count integer nullable
• image string nullable
• hover_image string nullable
• variation_type string nullable
• variant_count integer nullable
• more_colors_count integer nullable
• swatches array (default: [])
  • @type string (default: "SephoraSwatch")
  • sku_id string required
  • image string nullable
  • product_image string nullable
• beauty_insider_level string nullable
• is_sponsored boolean nullable
• is_new boolean nullable
• is_bestseller boolean nullable
• is_best 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 boolean nullable
• is_natural boolean nullable
• is_organic boolean nullable
• is_pickup_eligible boolean nullable
• is_pickup_nearby_eligible boolean nullable
• is_same_day_eligible boolean nullable
• is_next_day_eligible boolean nullable
• is_ship_to_home_eligible boolean nullable

Errors

• 422 — The keyword opens a whole Sephora category, which category_id cannot narrow. 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.