{ "openapi": "3.0.1", "info": { "title": "Shopify Store Scraper: Products, Prices & Stock", "description": "Scrape any Shopify store's full catalog from public products.json: prices, compare-at, variants, SKUs, stock and inventory. Track new, removed and price changes between runs. WooCommerce too. $1 per 1,000 products.", "version": "1.0", "x-build-id": "TkrZt3zrkPOb0zhO3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/impressionable_lupine~shopify-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-impressionable_lupine-shopify-store-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/impressionable_lupine~shopify-store-scraper/runs": { "post": { "operationId": "runs-sync-impressionable_lupine-shopify-store-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/impressionable_lupine~shopify-store-scraper/run-sync": { "post": { "operationId": "run-sync-impressionable_lupine-shopify-store-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": { "storeUrls": { "title": "Store URLs", "type": "array", "description": "Shopify store home pages, e.g. https://www.allbirds.com or allbirds.com. The whole public catalog is scraped (up to the per-store limit). Collection and product URLs pasted here are detected automatically.", "items": { "type": "string" } }, "collectionUrls": { "title": "Collection URLs (optional)", "type": "array", "description": "Scrape only these collections, e.g. https://www.allbirds.com/collections/mens. Uses /collections//products.json.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs (optional)", "type": "array", "description": "Scrape only these products, e.g. https://www.allbirds.com/products/mens-tree-runners. Uses /products/.js, which also returns inventory quantity when the store exposes it.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many products per store. Each delivered product is one billable event.", "default": 1000 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Add the variants[] array (id, SKU, title, options, price, compare-at price, availability, inventory quantity, barcode). Price min/max and availability counts are always included.", "default": true }, "includeInventory": { "title": "Include inventory quantity (slower)", "type": "boolean", "description": "Fetch /products/.js for every product to read variant inventory_quantity where the store exposes it. One extra request per product, so runs take longer. Same price per product.", "default": false }, "includeDescription": { "title": "Include description text", "type": "boolean", "description": "Add the product description as plain text (HTML stripped).", "default": false }, "trackChanges": { "title": "Track changes since the last run", "type": "boolean", "description": "Compare with the previous run (state kept in a named key-value store) and mark every product as new, price_changed, availability_changed or unchanged. Products that disappeared are emitted as removed (free). Schedule the Actor to get a price & stock monitor.", "default": false }, "onlyChanges": { "title": "Output only changed products", "type": "boolean", "description": "With change tracking on, skip unchanged products (they are not charged). The first run outputs every product as new.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that keeps the previous snapshot. Use different names for independent monitors. Lowercase letters, digits and dashes.", "default": "shopify-store-scraper-state" }, "analyzeStore": { "title": "Analyze store (+$0.005 per store)", "type": "boolean", "description": "Add one store profile record: theme, currency, country, contact page, emails, social links, detected apps (Klaviyo, Judge.me, Recharge…), product and collection counts.", "default": false }, "includeWooCommerce": { "title": "Also support WooCommerce stores", "type": "boolean", "description": "If a URL is not Shopify, try the public WooCommerce Store API (/wp-json/wc/store/v1/products).", "default": true }, "requestDelayMs": { "title": "Delay between requests to one store (ms)", "minimum": 200, "maximum": 10000, "type": "integer", "description": "Polite pacing per store host. 429 responses are retried with Retry-After / exponential backoff.", "default": 500 }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many different stores are scraped at the same time. Requests to a single store are always sequential.", "default": 3 } } }, "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 } } } } } } } } } }