{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper - Products & Price Change Monitor", "description": "Scrape products, variants, prices, stock and images from any Shopify store via its public products.json. Monitor mode reports only price drops/rises, back-in-stock, out-of-stock and new/removed products. Built for schedules and webhooks.", "version": "0.1", "x-build-id": "fY4HUqaN43svyQvo4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gazidev~shopify-products-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gazidev-shopify-products-monitor", "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/gazidev~shopify-products-monitor/runs": { "post": { "operationId": "runs-sync-gazidev-shopify-products-monitor", "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/gazidev~shopify-products-monitor/run-sync": { "post": { "operationId": "run-sync-gazidev-shopify-products-monitor", "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": "Shopify stores (domains or collection URLs)", "type": "array", "description": "Shopify store domains such as `allbirds.com`, or collection URLs such as `https://www.gymshark.com/collections/mens` to scrape only one collection. `https://` is added automatically. Sites that are not Shopify stores return a free `NOT_SHOPIFY` row.", "default": [ "allbirds.com" ], "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "**Scrape**: return every product, with variants, prices, stock and images. **Monitor**: compare with the previous run and return only changes (price drop or rise, back in stock, out of stock, new product, removed product). The first monitor run saves a baseline. Schedule monitor runs and add a webhook to get alerts.", "default": "scrape" }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Stop after this many products per store (0 = whole catalogue). In monitor mode, set this higher than the store's catalogue size: removed products are detected only when the whole catalogue was read.", "default": 250 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Add a `variants` array to every product: variant ID, title, SKU, price, compare-at price, availability, options, weight and image.", "default": true }, "includeDescription": { "title": "Include description text", "type": "boolean", "description": "Add the product description as plain text (HTML removed).", "default": true }, "includeStoreSummary": { "title": "Store summary row (scrape mode)", "type": "boolean", "description": "Add one summary row per store: product count, price range, median price, share of products on sale, average discount, top vendors, product types and tags. Charged as one `store-summary` event per store. Monitor mode never adds summary rows.", "default": true }, "fetchStoreInfo": { "title": "Fetch store name & currency", "type": "boolean", "description": "Read the store's public `/meta.json` (one extra request) to add the store name and currency to every row.", "default": true }, "currency": { "title": "Currency label (optional)", "type": "string", "description": "Informational only: overrides the currency code written to rows (e.g. `USD`). Prices are always the store's own prices. Leave empty to use the store's currency from `/meta.json`." }, "monitorKey": { "title": "Monitor state name", "type": "string", "description": "Name of the key-value store in your account that keeps the previous state for monitor mode (letters, digits, hyphens). Use different names for independent monitors. Default: `shopify-products-monitor-state`." }, "maxStores": { "title": "Max stores", "minimum": 0, "type": "integer", "description": "Process only the first N stores (0 = all). Useful for a cheap test of a long list.", "default": 0 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip stores whose robots.txt disallows `/products.json`, and honour Crawl-delay (up to 10 s). Requests to one store are always at least 1 second apart.", "default": true }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many stores are scraped at the same time. Each store gets one request at a time.", "default": 5 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-request timeout. Failed and rate-limited (429) requests are retried with backoff.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not needed for most stores. Apify datacenter proxy is on by default because many Shopify stores rate-limit cloud IPs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }