{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper", "description": "Scrape products from any Shopify store, collection or product URL: prices, compare-at and sale flag, variants with SKU and availability, optional stock counts and barcodes, images, tags, vendor, currency. Filters and a flat per-variant mode. $0.75 per 1,000 products.", "version": "0.1", "x-build-id": "15qiUB0PRXRr0FU2u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidyharvest~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidyharvest-shopify-products-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/tidyharvest~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-tidyharvest-shopify-products-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/tidyharvest~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-tidyharvest-shopify-products-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Stores, collection or product URLs", "type": "array", "description": "One per line. Any Shopify store on any custom domain: a domain (allbirds.com), a store URL, a collection URL (https://kith.com/collections/footwear) or a product URL (https://www.allbirds.com/products/mens-tree-runners). Non-Shopify sites are skipped and reported, not crashed on.", "items": { "type": "string" } }, "collections": { "title": "Collection handles (optional)", "type": "array", "description": "Only scrape these collections of every store above, e.g. 'sale' or 'mens'. Empty = the whole catalog.", "items": { "type": "string" } }, "maxItemsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Stop after this many products from each store. 0 or empty = the whole catalog." }, "maxItems": { "title": "Max products in total", "minimum": 0, "type": "integer", "description": "Hard cap on products for the whole run (also caps your cost). 0 or empty = no limit." }, "outputMode": { "title": "Output mode", "enum": [ "products", "variants" ], "type": "string", "description": "Variant mode emits one flat row per size/color with its own price, SKU and stock. Billing stays per product either way.", "default": "products" }, "keywords": { "title": "Keywords (match any)", "type": "array", "description": "Keep a product only if its title, description, vendor, type, tags, variant titles or SKUs contain one of these.", "items": { "type": "string" } }, "vendors": { "title": "Vendors / brands", "type": "array", "description": "Keep only these vendors (exact name, case-insensitive), e.g. Nike.", "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "Keep only these product types (exact, case-insensitive), e.g. Shoes.", "items": { "type": "string" } }, "tags": { "title": "Tags (match any)", "type": "array", "description": "Keep a product only if it has one of these tags (exact, case-insensitive).", "items": { "type": "string" } }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "In the store's currency. A product is kept when at least one variant is in range." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "In the store's currency." }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Keep only products (or variants) that are available to buy.", "default": false }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Keep only products (or variants) whose compare-at price is above the current price.", "default": false }, "updatedAfter": { "title": "Updated after", "type": "string", "description": "Keep only products updated on or after this date (YYYY-MM-DD). Handy for daily change tracking." }, "includeInventory": { "title": "Add stock counts (inventory enrichment)", "type": "boolean", "description": "Fetch each product's detail JSON for exact per-variant stock quantity, barcode/GTIN, inventory policy and quantity rules when the store exposes them. One extra request per product; charged only for products where stock counts were found.", "default": false }, "includeBodyHtml": { "title": "Include description HTML", "type": "boolean", "description": "Plain-text description is always included; turn this off to drop the raw HTML and keep rows small.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most stores. Turn on Apify Proxy only if a store blocks requests (HTTP 403/430)." } } }, "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 } } } } } } } } } }