{ "openapi": "3.0.1", "info": { "title": "Shopify & WooCommerce Product Scraper + Price Monitor", "description": "Scrape all products, prices, variants, stock, SKUs and barcodes from any Shopify or WooCommerce shop (plus other shops with schema.org data). Built-in price and stock change tracking. $1 per 1,000 products.", "version": "0.1", "x-build-id": "5REhVj2EWhNb9LScq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/henri_dewitte~shopify-woocommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-henri_dewitte-shopify-woocommerce-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/henri_dewitte~shopify-woocommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-henri_dewitte-shopify-woocommerce-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/henri_dewitte~shopify-woocommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-henri_dewitte-shopify-woocommerce-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": { "storeUrls": { "title": "Shops", "type": "array", "description": "Shop home page (all products), a collection or category page (only those products) or one product page. Examples: https://kith.com, https://www.allbirds.com/collections/mens, https://woocommerce.com/products/. Max 1,000.", "default": [ "https://kith.com" ], "items": { "type": "string" } }, "platform": { "title": "Platform", "enum": [ "auto", "shopify", "woocommerce", "jsonld" ], "type": "string", "description": "Leave on \"Detect automatically\". Shopify and WooCommerce are read via their fast public product API. Other shops are read via the schema.org product data on their product pages (found via the sitemap).", "default": "auto" }, "maxProductsPerStore": { "title": "Max products per shop", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many products per shop. Leave empty for all products." }, "splitVariants": { "title": "One row per variant", "type": "boolean", "description": "One row per size/colour with its own price, stock, SKU and barcode, instead of one row per product (with all variants inside). Note: you pay per row.", "default": false }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Add the product description as clean text (max 5,000 characters).", "default": true }, "trackChanges": { "title": "Track price and stock changes", "type": "boolean", "description": "Remember prices and stock between runs. Every row then says what changed: new, price-drop, price-increase, back-in-stock, out-of-stock or unchanged, with the previous price.", "default": true }, "onlyChanged": { "title": "Only new and changed products (price monitor)", "type": "boolean", "description": "Only return products that are new or whose price or stock changed since the last run. Schedule the Actor daily to get a cheap price and stock monitor of competitors. The first run returns all products.", "default": false }, "maxResults": { "title": "Max products (total)", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of rows this run saves (and you pay for).", "default": 1000 } } }, "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 } } } } } } } } } }