{ "openapi": "3.0.1", "info": { "title": "Shopify Store Monitor - Product, Price & Stock Change Scraper", "description": "Monitor competitor Shopify stores: new and removed products, price drops and increases, sales (compare-at price) started or ended, and sold-out / back-in-stock variants since the last run. Reads the public products.json feed; headless stores fall back to myshopify.com. Optional full product export.", "version": "1.0", "x-build-id": "sqjMQjSXhtvDdHpTI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ivora~shopify-store-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ivora-shopify-store-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/ivora~shopify-store-monitor/runs": { "post": { "operationId": "runs-sync-ivora-shopify-store-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/ivora~shopify-store-monitor/run-sync": { "post": { "operationId": "run-sync-ivora-shopify-store-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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores", "type": "array", "description": "Store domains or URLs, e.g. allbirds.com, https://www.gymshark.com or weareallbirds.myshopify.com. A collection URL (…/collections/) monitors only that collection.", "items": { "type": "string" } }, "mode": { "title": "Output", "enum": [ "changes", "allProducts" ], "type": "string", "description": "changes = new / removed products, price, sale and stock changes since the previous run. allProducts = one row per product every run (charged per row like a change).", "default": "changes" }, "firstRunBehavior": { "title": "First run of a monitor", "enum": [ "baseline", "outputProducts" ], "type": "string", "description": "On the very first run there is nothing to compare with. baseline = only store the catalog (you pay just the store check). outputProducts = also output the current products (newest first), charged per row; use 'Product rows limit' to cap them.", "default": "baseline" }, "productRowsLimit": { "title": "Product rows limit per store", "minimum": 0, "type": "integer", "description": "Caps full product rows (first-run output and 'All products' mode) per store and run, newest products first. 0 = no limit. Change rows are never capped.", "default": 0 }, "changeTypes": { "title": "Change types", "type": "array", "description": "Which change rows to output. All changes are still counted in the free summary row.", "items": { "type": "string", "enum": [ "newProduct", "priceChange", "compareAtChange", "stockChange", "variantsChange", "removedProduct" ], "enumTitles": [ "New products", "Price changes", "Sale started / ended (compare-at price)", "Sold out / back in stock", "Variants added / removed", "Removed products" ] }, "default": [ "newProduct", "priceChange", "compareAtChange", "stockChange", "variantsChange", "removedProduct" ] }, "minPriceChangePct": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Ignore price changes smaller than this percentage (0 = report every change).", "default": 0 }, "productKeywords": { "title": "Only products matching keywords", "type": "array", "description": "Optional: output only products whose title, vendor, product type or tags contain one of these words (case-insensitive). The whole catalog is still tracked.", "items": { "type": "string" } }, "includeVariants": { "title": "Include variants in product rows", "type": "boolean", "description": "Add the variant list (title, SKU, price, compare-at price, available) to product and new-product rows.", "default": true }, "includeDescription": { "title": "Include product description", "type": "boolean", "description": "Add the product description as plain text (first 2,000 characters) to product rows.", "default": false }, "includeSummary": { "title": "Summary row per store", "type": "boolean", "description": "Free row per store: product and variant counts, sold-out and on-sale counts, price range, top vendors and product types, newest products and change counts.", "default": true }, "maxProductsPerStore": { "title": "Max products read per store", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Safety cap for huge catalogs (Shopify's public feed stops at 25,000). If a catalog is cut off, removed-product detection is off for that store.", "default": 10000 }, "stateStoreName": { "title": "Monitor state store name", "type": "string", "description": "Named key-value store that remembers each store's catalog between runs. Use a different name for each independent monitor (a-z, 0-9, -).", "default": "shopify-store-monitor-state" }, "residentialFallback": { "title": "Residential proxy fallback", "type": "boolean", "description": "If a store blocks the request (HTTP 403/429), retry it through Apify residential proxy automatically (at most 5,000 products per store that way).", "default": true }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many stores are read at the same time. Requests to one store are always paced.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed for most stores (the feed is public). The residential fallback above handles stores that block.", "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 } } } } } } } } } }