{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper - Products, Prices, Variants & Stock", "description": "Scrape any public Shopify store's products: title, price range, variants, SKUs, images, availability and dates. Just add store links. For price monitoring and catalog research. Export to CSV, JSON or Excel, schedule runs or use the API.", "version": "1.0", "x-build-id": "byIMapxcTzh5cMfwp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Store URLs", "type": "array", "description": "Public Shopify store URLs to scrape (one per line). Accepts a bare domain (allbirds.com), the store home page, or any product/collection URL — only the store origin is used. The store's public product catalog is read.", "items": { "type": "string" } }, "collections": { "title": "Collections (optional)", "type": "array", "description": "Optional. Collection handles or collection URLs to scrape instead of the whole catalog (for example: mens-shoes, or https://www.allbirds.com/collections/mens-shoes). When set, only products in these collections are fetched, applied to every store. Leave empty to scrape all products.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of products to collect from each store (after filtering). Use a small number for quick tests and a larger one for a full catalog export.", "default": 1000 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "When enabled, each product record includes the full list of variants (price, compare-at price, SKU, options, availability). Disable for a lighter record with only the aggregate price range.", "default": true }, "includeImages": { "title": "Include images", "type": "boolean", "description": "When enabled, each product record includes the list of product image URLs. Disable to omit image URLs.", "default": true }, "onlyAvailable": { "title": "Only available products", "type": "boolean", "description": "When enabled, products with no purchasable (in-stock) variant are skipped.", "default": false }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Optional. Only keep products whose lowest variant price is at least this value (in the store's currency). Leave empty for no lower bound." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Optional. Only keep products whose lowest variant price is at most this value (in the store's currency). Leave empty for no upper bound." }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Use Apify Proxy. Recommended; the default works for most stores.", "default": true }, "proxyGroups": { "title": "Proxy groups (optional)", "type": "array", "description": "Optional proxy groups. Leave empty for the default. If a store comes back empty, try a different proxy option. Only applies when 'Use Apify Proxy' is enabled.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }