{ "openapi": "3.0.1", "info": { "title": "Shopify Product Scraper", "description": "Extract complete product data from any Shopify store including prices, discounts, variants (up to 250 per product), customer reviews, ratings, and sales estimates. Bonus: discover 321K+ Shopify stores by category.", "version": "1.0", "x-build-id": "OeyliGX1g968xInPp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatalabs~shopify-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatalabs-shopify-product-scraper", "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/webdatalabs~shopify-product-scraper/runs": { "post": { "operationId": "runs-sync-webdatalabs-shopify-product-scraper", "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/webdatalabs~shopify-product-scraper/run-sync": { "post": { "operationId": "run-sync-webdatalabs-shopify-product-scraper", "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", "properties": { "mode": { "title": "Mode", "enum": [ "url", "discovery" ], "type": "string", "description": "Choose how to find stores: provide specific URLs or discover stores from cro.media directory (321,000+ stores)", "default": "url" }, "category": { "title": "Store Category", "enum": [ "", "fashion", "fashion/shoes", "fashion/jewellery", "fashion/bags", "fashion/lingerie", "fashion/outerwear", "fashion/swimwear", "fashion/activewear", "fashion/kids", "beauty", "skincare", "skincare/serum", "skincare/mask", "skincare/cleanser", "skincare/sunscreen", "skincare/acne", "skincare/toner", "skincare/exfoliant", "haircare", "haircare/shampoo", "haircare/conditioner", "haircare/styling", "haircare/tools", "food", "food/snack", "food/candy", "food/bakery", "food/meat", "food/seafood", "food/vegan", "food/organic", "food/glutenfree", "food/coffee", "food/tea", "food/alcohol", "electronics", "electronics/phone", "electronics/computer", "electronics/camera", "electronics/audio", "electronics/wearable", "home", "home/furniture", "home/lighting", "home/decor", "home/storage", "kitchen", "kitchen/appliance", "kitchen/cookware", "kitchen/utensil", "kitchen/storage", "kitchen/tableware", "kitchen/drinkware", "sports", "sports/equipment", "sports/clothing", "pets", "pets/food", "pets/accessory", "pets/health", "baby", "baby/clothing", "baby/gear", "baby/feeding", "baby/toys", "bedding", "bedding/blanket", "bedding/sleepwear", "bedding/mattress", "bedding/pillow", "bedding/duvet", "bathroom", "bathroom/accessory", "bath-body", "bath-body/oil", "bath-body/lotion", "bath-body/scrub", "dental", "dental/toothbrush", "dental/toothpaste", "dental/mouthwash", "dental/floss", "dental/whitening", "eyewear", "eyewear/glasses", "eyewear/sunglasses", "eyewear/contactlens", "watches", "bags", "accessories", "gifts", "flowers", "party", "books", "music", "art", "crafts", "outdoors", "automotive", "automotive/parts", "automotive/accessory", "tools", "office", "office/furniture", "office/supplies", "safety", "cleaning", "energy", "heating-cooling", "building", "alcohol", "adult/18plus" ], "type": "string", "description": "Filter stores by category (leave empty for all stores). Examples: fashion, electronics, food/coffee, skincare/serum", "default": "" }, "maxStores": { "title": "Max Stores to Discover", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of stores to extract from the directory", "default": 1000 }, "maxPages": { "title": "Max Pages to Scrape", "minimum": 1, "maximum": 220, "type": "integer", "description": "Maximum number of directory pages to scrape (each page has ~300 stores, max 220 pages)", "default": 10 }, "storeUrls": { "title": "Shopify Store URLs", "type": "array", "description": "Enter Shopify store URLs to scrape product data (e.g., https://gymshark.com). Only used in URL mode.", "default": [ { "url": "https://www.allbirds.com" } ] }, "maxProducts": { "title": "Max Products to Scrape", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of products to extract per store (0 = unlimited). Only used in URL mode.", "default": 100 }, "proxyConfiguration": { "title": "Proxy Settings", "type": "object", "description": "Use Apify proxies for reliable scraping (recommended for large stores)", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }