{ "openapi": "3.0.1", "info": { "title": "Sephora Catalog Price & Rating Finder", "description": "Search Sephora's product catalog by keyword, bestsellers, or new arrivals, filtered by rating, brand, and price, with merchandising flags, review counts, and images for every matching product.", "version": "1.0", "x-build-id": "CmWi1inWXx3Khxocm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~sephora-catalog-price-and-rating-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-sephora-catalog-price-and-rating-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/dataspryva~sephora-catalog-price-and-rating-finder/runs": { "post": { "operationId": "runs-sync-dataspryva-sephora-catalog-price-and-rating-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/dataspryva~sephora-catalog-price-and-rating-finder/run-sync": { "post": { "operationId": "run-sync-dataspryva-sephora-catalog-price-and-rating-finder", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "category", "brand", "product", "bestsellers", "newArrivals", "sale", "reviews", "questions" ], "type": "string", "description": "What to fetch: keyword search, category or brand browse, product URLs, bestsellers, new arrivals, sale, reviews or questions.", "default": "search" }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search (mode=search). Enter one or more terms, e.g. `moisturizer`, `vitamin c serum`.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Category slugs, `cat...` IDs or Sephora category URLs (mode=category, bestsellers, newArrivals, sale; also a filter in search). Empty browse modes use the six top-level categories.", "default": [], "items": { "type": "string" } }, "brands": { "title": "Brands", "type": "array", "description": "Brand names, slugs or Sephora brand URLs (mode=brand; also an optional filter in other listing modes). Example: `Rare Beauty` or `/brand/rare-beauty-by-selena-gomez`.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "Sephora product URLs or `P...` IDs (mode=product, reviews, questions). A `?skuId=` in the URL selects that variant.", "default": [], "items": { "type": "string" } }, "market": { "title": "Market", "enum": [ "us", "ca-en", "ca-fr" ], "type": "string", "description": "Storefront and currency: United States (USD), Canada English (CAD) or Canada French (CAD).", "default": "us" }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "bestSelling", "topRated", "priceLowToHigh", "priceHighToLow", "newArrivals" ], "type": "string", "description": "Result ordering for listing modes. Bestsellers and sale default to best selling; new arrivals default to newest.", "default": "relevance" }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only include products rated at or above this value (1-5)." }, "priceMin": { "title": "Minimum price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only include products whose current price is at or above this amount, in the selected market's currency." }, "priceMax": { "title": "Maximum price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only include products whose current price is at or below this amount, in the selected market's currency." }, "includeNewOnly": { "title": "New products only", "type": "boolean", "description": "Only include products Sephora flags as new.", "default": false }, "includeBestsellersOnly": { "title": "Bestsellers only", "type": "boolean", "description": "Only include products flagged as bestsellers in listing modes. Not available in product-URL mode.", "default": false }, "saleOnly": { "title": "On sale only", "type": "boolean", "description": "Only include products currently discounted by Sephora.", "default": false }, "refinements": { "title": "Advanced refinements", "type": "array", "description": "Optional Sephora facet values, e.g. `filters[skinType]=drySk` or `filters[ingredientPreferences]=crueltyFree`. Up to 20.", "default": [], "items": { "type": "string" } }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Fetch descriptions, ingredients, highlights, variants, stock, category path and brand information for every product in listing modes. Product-URL mode always includes details.", "default": false }, "includeImages": { "title": "Include rehosted images", "type": "boolean", "description": "Copy product images into the run's key-value store so the image links stay publicly accessible.", "default": true }, "maxImagesPerProduct": { "title": "Maximum images per product", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of product images to keep and rehost for each product.", "default": 3 }, "includeReviews": { "title": "Include review samples", "type": "boolean", "description": "Add recent or most-helpful review samples to product records, and fetch review samples in reviews mode.", "default": false }, "maxReviewsPerProduct": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum review rows or samples per product.", "default": 20 }, "reviewsSort": { "title": "Review order", "enum": [ "mostHelpful", "newest", "oldest", "highestRating", "lowestRating" ], "type": "string", "description": "Ordering for review rows and review samples.", "default": "mostHelpful" }, "includeReviewStats": { "title": "Include review statistics", "type": "boolean", "description": "Add the rating histogram, recommendation counts, review dates and GTIN/UPC/EAN identifiers.", "default": false }, "includeQuestions": { "title": "Include questions and answers", "type": "boolean", "description": "Add questions with their answers to product records, and fetch question rows in questions mode.", "default": false }, "maxQuestionsPerProduct": { "title": "Maximum questions per product", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum question rows or embedded questions per product.", "default": 10 }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on all records emitted by the run.", "default": 50 }, "maxItemsPerQuery": { "title": "Maximum records per source", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Cap records per keyword, category, brand or product URL. 0 means no per-source cap.", "default": 0 }, "onlyNewProducts": { "title": "Only new products", "type": "boolean", "description": "Skip product IDs that were already returned under the same state key in earlier runs.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name for the saved product-ID state used by 'Only new products'.", "default": "default" }, "resetState": { "title": "Reset saved state", "type": "boolean", "description": "Forget previously seen product IDs for this state key before the run.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Sephora's public catalog and review endpoints work without a proxy.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }