/ulta/categories/products

POST /api/ulta/categories/products

Price: 20 credits

List the products in an Ulta Beauty category, with brand, price, rating and attribute filters

How to use it

List one Ulta Beauty category, given as the path after /shop/ in an Ulta URL or the URL itself; a department such as makeup lists every product in it. Several values in one filter match any of them, and brand names must match Ulta's spelling and case, or nothing matches. Pass a returned id to the Ulta product endpoint for full details.

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)
• min_price integer nullable — Minimum price in whole USD (min: 0)
• max_price integer nullable — Maximum price in whole USD (>: 0)
• min_rating integer nullable — Minimum average star rating (min: 1; max: 5)
• is_waterproof boolean — Only waterproof products when true (default: false)
• skin_types array nullable — Skin types (one of: "all", "combination", "dry", "no_spf", "normal", "oily", "sensitive")
• concerns array nullable — Skin and hair concerns (one of: "acne_and_blemishes", "anti_aging", "blackheads_and_visible_pores", "color_protection", "curl_enhancing", "damaged", "dandruff", "dark_circles", "dark_spots", "dark_spots_and_uneven_skin_tone", "dry_scalp", "dryness", "dullness", "frizz_free", "heat_protection", "oil_control", "oiliness", "puffiness", "redness", "shine", "straightening", "thinning", "tone", "uneven_skin_tone", "volume")
• hair_concerns array nullable — Hair concerns and effects (one of: "anti_aging", "color_safe", "curl", "curl_enhancing", "detangle", "heat_protection", "hold", "hydrate", "repair", "shine", "smooth", "straighten", "texturizing", "uv_protection", "volumizing")
• preferences array nullable — Ingredient and product preferences (one of: "aha_glycolic_acid", "alcohol_free", "antioxidants", "clean_ingredients", "collagen", "contains_cbd", "cruelty_free", "fragrance_free", "give_back", "gluten_free", "hyaluronic_acid", "matte", "mineral", "natural", "niacinamide", "non_comedogenic", "oil_free", "paraben_free", "peptides", "phthalate_free", "radiant", "retinoid", "salicylic_acid", "silicone_free", "squalane", "sulfate_free", "sustainable_packaging", "talc_free", "vegan", "vitamin_c", "zinc")
• benefits array nullable — Benefits (one of: "active_lifestyle", "boost_energy", "brain_and_memory_support", "curling", "digestive_health", "dramatic", "full", "hair_nail_and_skin_support", "heart_support", "hydration", "immune_support", "lash_enhancer", "lengthening", "liver_and_cleanse", "longwear", "magnetic", "menopause_support", "metabolism_and_weight_support", "mood_support", "multivitamin", "natural_look", "pms_support", "post_partum_care", "prenatal_care", "respiratory_support", "sexual_health", "sleep_support", "stress_support", "tubing", "vaginal_health", "volumizing", "waterproof")
• forms array nullable — Product forms (one of: "aerosol", "balm", "bar", "capsules", "cream", "foam", "gel", "glitter", "gloss", "gummies", "liquid", "liquids_and_syrups", "loose_powder", "lotion", "mousse", "non_aerosol", "oil", "oil_and_serum", "patch", "pencil", "pomade", "powder", "powders", "pressed_powder", "scrub", "serum", "spray", "stain", "stick", "wax")
• finishes array nullable — Finishes (one of: "cream", "glitter", "high_shine", "matte", "metallic", "natural", "radiant", "sheer", "shimmer")
• coverages array nullable — Coverage levels (one of: "buildable", "full", "light", "medium")
• spf_levels array nullable — SPF levels (one of: "15_30", "15_plus", "30_plus", "50_plus", "70_plus", "above_30", "below_15", "no_spf", "under_15")
• colors array nullable — Face makeup color families (one of: "black", "blue", "brown", "clear", "gold", "green", "grey", "multi", "neutral", "orange", "pink", "purple", "red", "white", "yellow")
• eye_colors array nullable — Eye makeup color families (one of: "auburn", "black", "blonde", "blue", "brown", "brunette", "clear", "gold", "green", "grey", "multi", "nude", "orange", "pink", "purple", "red", "silver", "taupe", "universal", "white", "yellow")
• lip_colors array nullable — Lip color families (one of: "beige", "berry", "brown", "clear", "coral", "multi", "non_traditional", "orange", "pink", "purple", "red", "wine")
• nail_colors array nullable — Nail color families (one of: "beige", "black", "blue", "brown", "clear", "gold", "green", "grey", "multi", "orange", "pink", "purple", "red", "silver", "turquoise", "white", "yellow")
• hair_colors array nullable — Hair color families (one of: "auburn", "black", "blonde", "blue", "brown", "brunette", "clear", "gold", "green", "grey", "multi", "orange", "pink", "purple", "red", "silver", "white", "yellow")
• scents array nullable — Scent families (one of: "floral", "fresh", "fruity_and_citrus", "sweet", "warm_and_spicy", "woody_and_earthy")
• fragrance_types array nullable — Fragrance concentrations (one of: "eau_de_cologne", "eau_de_parfum", "eau_de_toilette", "eau_fraiche", "parfum")
• purposes array nullable — Tool and nail product purposes (one of: "application", "blending", "contouring", "curling", "fast_drying", "growth", "highlighting", "lining", "matte", "shading", "sharpening", "strengthening")
• treatments array nullable — Body treatments (one of: "acne", "anti_stress", "brightening", "cellulite", "dryness", "hand_and_foot", "stretch_marks", "tightening")
• product_types array nullable — Product types (one of: "body", "brushes_for_body", "brushes_for_cheeks", "brushes_for_eyes", "brushes_for_face", "brushes_for_lips", "ceramic", "coily", "curly", "digital", "dual_voltage", "face", "gold", "infrared", "ionic", "kids", "makeup_bags", "organization", "reef_safe", "sponges_and_applicators", "sport", "straight", "temporary", "titanium", "tourmaline", "train_cases", "water_resistant", "waterproof", "wavy", "wet_dry")
• brush_types array nullable — Makeup brush types (one of: "angle", "bronzer", "cheek", "concealer", "eyebrow", "eyeliner", "eyeshadow", "foundation", "highlight", "lip", "powder")
• hair_brush_types array nullable — Hair brush types (one of: "detangling", "styling")
• hair_brush_shapes array nullable — Hair brush shapes (one of: "comb", "paddle", "round")
• mascara_types array nullable — Mascara types (one of: "curling", "lengthening", "volumizing")
• eyelash_types array nullable — False eyelash types (one of: "magnetic", "natural", "strip")
• materials array nullable — Materials (one of: "acrylic", "bamboo", "foam", "glass", "marble", "metal", "plastic", "rubber", "silicone")
• shopping_preferences array nullable — Shopping preferences (one of: "dermatologist_recommended", "fsa_hsa_eligible", "k_beauty", "online_only", "only_at_ulta", "refill", "refillable", "replenish_and_save_eligible")
• special_offers array nullable — Special offers (one of: "buy_more_save_more", "gift_with_purchase", "on_sale")
• brands array nullable — Brand names as Ulta spells them (examples: ["Morphe"], ["Clinique","Estée Lauder"])
• category string required — Ulta category path or URL (examples: "makeup/face", "skin-care/moisturizers", "https://www.ulta.com/shop/makeup/face/blush"; minLength: 1)
• sort string — Result ordering (default: "best_sellers"; one of: "best_sellers", "price_low_to_high", "price_high_to_low", "new_arrivals", "top_rated")

Response

• @type string (default: "UltaListingProduct")
• id string required
• sku_id string nullable
• url string nullable
• name string nullable
• brand string nullable
• image string nullable
• rating number nullable
• review_count integer nullable
• list_price number nullable
• list_price_max number nullable
• sale_price number nullable
• sale_price_max number nullable
• discount number nullable
• kit_price number nullable
• price_label string nullable
• variant_label string nullable
• promo_text string nullable
• offers_text string nullable
• badges array (default: [])
• is_limited_stock boolean 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 Ulta category has this path. 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.