{ "openapi": "3.0.1", "info": { "title": "Shein Product Image Search", "description": "Scrape product data from Shein with this powerful visual search tool. Upload an image to find similar products, extracting price, images, name,discounted prices, stock, category, and more. Download response as HTML table, JSON, CSV, Excel, XML, or RSS feed.", "version": "0.0", "x-build-id": "Gdz3Z7nRzUrL6gGaD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/factual_biscotti~shein-visual-search-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-factual_biscotti-shein-visual-search-actor", "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/factual_biscotti~shein-visual-search-actor/runs": { "post": { "operationId": "runs-sync-factual_biscotti-shein-visual-search-actor", "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/factual_biscotti~shein-visual-search-actor/run-sync": { "post": { "operationId": "run-sync-factual_biscotti-shein-visual-search-actor", "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": [ "image_source", "max_results" ], "properties": { "image_source": { "title": "Image Source", "type": "string", "description": "The image to use for visual search. Can be a local file path (e.g., 'sample.jpg'), a URL (e.g., 'https://example.com/image.jpg'), or raw image bytes (for Apify file uploads)." }, "country": { "title": "Country Code", "enum": [ "US", "UK", "DE", "FR", "ES", "IT", "EUR", "ROE", "CA", "AU", "NL", "AT", "CH", "SE", "PL", "PT", "JP", "ZA", "KR", "MX", "SG", "IL", "TR" ], "type": "string", "description": "Country code for pricing and currency (e.g., 'US', 'UK', 'DE', 'NL'). Default is 'US'.", "default": "US" }, "max_results": { "title": "Maximum Results", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of products to return (1-50).", "default": 5 }, "include_out_of_stock": { "title": "Include Out-of-Stock Products", "type": "boolean", "description": "If true, includes out-of-stock products in the results. Default is false.", "default": false }, "use_proxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "If true, uses Apify proxy for requests. Default is false.", "default": false }, "fields": { "title": "Output Fields", "type": "array", "description": "Specific fields to include in the output. Leave empty to get ALL comprehensive fields including nested structures. Examples: ['Product Rank', 'Product Name', 'Current Price with Symbol', 'Main Product Image']", "items": { "type": "string", "enum": [ "rank", "goods_id", "goods_sn", "product_relation_id", "spu", "from_sku_code", "name", "goods_url_name", "detail_url", "category_id", "category_name", "parent_ids", "price", "price_with_symbol", "original_price", "original_price_with_symbol", "discount_percent", "currency", "product_image", "matching_image_url", "detail_images", "brand_name", "collection_name", "stock", "is_on_sale", "relevance_score", "quickship", "material_info", "pricing", "pricing.currency", "pricing.sale_price", "pricing.sale_price.amount", "pricing.sale_price.amount_with_symbol", "pricing.sale_price.usd_amount", "pricing.sale_price.usd_amount_with_symbol", "pricing.sale_price.price_show_style", "pricing.retail_price", "pricing.retail_price.amount", "pricing.retail_price.amount_with_symbol", "pricing.retail_price.usd_amount", "pricing.retail_price.usd_amount_with_symbol", "pricing.retail_price.price_show_style", "pricing.discount_price", "pricing.discount_price.amount", "pricing.discount_price.amount_with_symbol", "pricing.discount_price.usd_amount", "pricing.discount_price.usd_amount_with_symbol", "pricing.discount_price.price_show_style", "pricing.retail_discount_price", "pricing.retail_discount_price.amount", "pricing.retail_discount_price.amount_with_symbol", "pricing.retail_discount_price.usd_amount", "pricing.retail_discount_price.usd_amount_with_symbol", "pricing.retail_discount_price.price_show_style", "pricing.suggested_sale_price", "pricing.suggested_sale_price.amount", "pricing.suggested_sale_price.amount_with_symbol", "pricing.suggested_sale_price.usd_amount", "pricing.suggested_sale_price.usd_amount_with_symbol", "pricing.suggested_sale_price.price_show_style", "pricing.srp_discount_price", "pricing.srp_discount_price.amount", "pricing.srp_discount_price.amount_with_symbol", "pricing.srp_discount_price.usd_amount", "pricing.srp_discount_price.usd_amount_with_symbol", "pricing.srp_discount_price.price_show_style", "pricing.discount_info", "pricing.discount_info.retail_discount_percent", "pricing.discount_info.unit_discount", "pricing.discount_info.original_discount", "pricing.discount_info.srp_discount", "pricing.discount_info.is_inversion", "pricing.discount_info.is_srp_inversion", "images", "images.product_image", "images.goods_color_image", "images.detail_images", "images.matching_image_url", "brand_info", "brand_info.brand_name", "brand_info.brand_id", "brand_info.brand_code", "brand_info.brand_badge_name", "brand_info.collection_name", "brand_info.series_id", "brand_info.second_series_id", "brand_info.series_logo_url", "brand_info.product_recommend_by_group", "availability", "availability.stock", "availability.is_on_sale", "availability.sold_out_status", "availability.product_stock_check_log", "store_info", "store_info.store_code", "store_info.mall_code", "store_info.business_model", "product_labels", "product_labels.goods_common_labels", "product_labels.feature_subscript", "product_labels.product_info_labels", "services", "services.quickship", "services.is_clearance", "services.is_show_plus_size", "promotions", "promotions.promotion_info", "promotions.is_new_coupon", "promotions.coupon_prices", "promotions.is_show_additional_discount", "product_material", "product_material.material_info", "product_material.upper_left_position_info", "product_material.lower_right_position_info", "product_material.picture_belt", "product_material.full_price_ui", "product_material.show_add_button_label", "product_material.show_add_button_label_style", "product_material.v2_product_attribute_label_list", "display_info", "display_info.new_product_price_style_show", "display_info.new_product_price_style_symbol", "display_info.reorder", "display_info.use_position_info", "display_info.is_single_sku", "media", "media.video_url", "tags", "tags.act_tag_from_ccc", "tags.relevance_score", "tags.ext" ], "enumTitles": [ "Search Rank", "Product ID", "Product SKU", "Product Relation ID", "SPU Code", "SKU Code Reference", "Product Name", "URL Product Name", "Product Detail URL", "Category ID", "Category Name", "Parent Category IDs", "Current Price (Number)", "Current Price with Symbol", "Original Price (Number)", "Original Price with Symbol", "Discount Percentage", "Currency Code", "Main Product Image", "Search Image URL", "Additional Product Images", "Brand Name", "Collection Name", "Stock Quantity", "On Sale Status", "Search Relevance Score", "Quick Ship Available", "Basic Material Info", "Complete Pricing Data", "Pricing Currency", "Sale Price Details", "Sale Price Amount", "Sale Price with Symbol", "Sale Price USD Amount", "Sale Price USD with Symbol", "Sale Price Display Style", "Retail Price Details", "Retail Price Amount", "Retail Price with Symbol", "Retail Price USD Amount", "Retail Price USD with Symbol", "Retail Price Display Style", "Discount Price Details", "Discount Price Amount", "Discount Price with Symbol", "Discount Price USD Amount", "Discount Price USD with Symbol", "Discount Price Display Style", "Retail Discount Price Details", "Retail Discount Amount", "Retail Discount with Symbol", "Retail Discount USD Amount", "Retail Discount USD with Symbol", "Retail Discount Display Style", "Suggested Sale Price Details", "Suggested Sale Amount", "Suggested Sale with Symbol", "Suggested Sale USD Amount", "Suggested Sale USD with Symbol", "Suggested Sale Display Style", "SRP Discount Price Details", "SRP Discount Amount", "SRP Discount with Symbol", "SRP Discount USD Amount", "SRP Discount USD with Symbol", "SRP Discount Display Style", "Discount Information", "Retail Discount Percentage", "Unit Discount", "Original Discount", "SRP Discount", "Inversion Status", "SRP Inversion Status", "All Image Data", "Main Product Image URL", "Color Variant Image", "Detail Images Array", "Original Search Image", "Complete Brand Information", "Brand Name", "Brand ID", "Brand Code", "Brand Badge Name", "Collection/Series Name", "Series ID", "Second Series ID", "Series Logo URL", "Product Recommendation Group", "Stock & Availability Data", "Available Stock", "Currently On Sale", "Sold Out Status", "Stock Check Log", "Store Information", "Store Code", "Mall Code", "Business Model Type", "Product Labels & Tags", "Product Common Labels", "Feature Highlights", "Additional Product Labels", "Services & Shipping", "Quick Shipping Available", "Clearance Item", "Plus Size Available", "Promotions & Deals", "Active Promotion Details", "New Coupon Available", "Available Coupon Prices", "Additional Discount Available", "Material & Styling Data", "Complete Material Information", "Upper Left UI Position", "Lower Right UI Position", "Image Styling Belt", "Price UI Configuration", "Add Button Label Setting", "Add Button Label Style", "Product Attribute Labels V2", "Display & Technical Info", "Price Style Show Setting", "Price Style Symbol", "Reorder Capability", "Position Info Usage", "Single SKU Indicator", "Media Content", "Product Video URL", "Tags & Metadata", "Activity Tags & Styling", "Search Relevance Score", "Extended Metadata" ] } } } }, "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 } } }, "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 } } } } } } } } } }