{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper - Prices, Variants, Stock & Monitoring", "description": "Export all products from any Shopify store: prices, variants, SKUs, stock, images and discounts. Works on headless stores, monitors new products and price changes. Pay per product.", "version": "0.1", "x-build-id": "STZxWT73Eqatutpj7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tinyrex~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tinyrex-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/tinyrex~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-tinyrex-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/tinyrex~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-tinyrex-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", "properties": { "stores": { "title": "Shopify stores, collections or products", "type": "array", "description": "Store domains (allbirds.com), store URLs, collection URLs (https://store.com/collections/sale) or product URLs (https://store.com/products/handle). Headless stores are supported when their *.myshopify.com domain can be found. Inputs that are not Shopify stores are skipped and not charged.", "default": [ "deathwishcoffee.com", "https://www.allbirds.com/collections/mens" ], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Maximum number of products to save per input (after filters). 0 = all products.", "default": 0 }, "outputMode": { "title": "Output: one row per", "enum": [ "products", "variants" ], "type": "string", "description": "Product: one row per product with a nested variants list. Variant: one flat row per variant (size/color), easiest for spreadsheets and price tracking. One charge per row.", "default": "products" }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only products whose title, vendor, product type or tags contain any of these words (case-insensitive).", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop products whose title or tags contain any of these words.", "default": [], "items": { "type": "string" } }, "vendors": { "title": "Vendors / brands", "type": "array", "description": "Keep only products from these vendors (partial match).", "default": [], "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "Keep only these product types (partial match), e.g. Shoes, Coffee.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest variant price must be at least this (store currency). Leave empty for no limit." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Lowest variant price must be at most this (store currency). Leave empty for no limit." }, "onlyAvailable": { "title": "Only in stock", "type": "boolean", "description": "Keep only products with at least one variant available for sale.", "default": false }, "onlyOnSale": { "title": "Only on sale", "type": "boolean", "description": "Keep only products with a compare-at price higher than the price (discounted).", "default": false }, "publishedWithinDays": { "title": "Published within (days)", "minimum": 0, "type": "integer", "description": "Keep only products published in the last N days. 0 = any time.", "default": 0 }, "descriptionFormat": { "title": "Description", "enum": [ "text", "html", "both", "none" ], "type": "string", "description": "Product description as plain text, HTML, both, or none (smaller output).", "default": "text" }, "includeInventory": { "title": "Add stock quantity and barcode (extra charge)", "type": "boolean", "description": "Fetches each product page feed to add inventory quantity, inventory policy and barcode per variant, when the store exposes them. Slower (one extra request per product). Charged per product where stock data was found.", "default": false }, "monitorMode": { "title": "Monitoring mode", "enum": [ "off", "new", "changes" ], "type": "string", "description": "Off: return all matching products. New: only products not seen in previous runs. Changes: new products plus price, compare-at price or availability changes (with previous values). State is kept per store under the state key. The first monitoring run returns everything as the baseline.", "default": "off" }, "stateKey": { "title": "State key", "type": "string", "description": "Name of the monitoring state. Use different keys for different schedules or filters.", "default": "default" }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many stores are processed at the same time. Pages of one store are fetched politely one after another.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed. Use a proxy if a store blocks requests (HTTP 403/429).", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }