{
"openapi": "3.0.1",
"info": {
"title": "Shopify Store Scraper & Monitor – Prices, Stock, New Products",
"description": "Scrape every product of any Shopify store and monitor it: new and removed products, price drops and increases, discounts, sold-out and back-in-stock changes, with Slack/webhook alerts and a shareable report.",
"version": "1.0",
"x-build-id": "JG6jY74XfMF7chjKS"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/kirozhang~shopify-store-monitor/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-kirozhang-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/kirozhang~shopify-store-monitor/runs": {
"post": {
"operationId": "runs-sync-kirozhang-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/kirozhang~shopify-store-monitor/run-sync": {
"post": {
"operationId": "run-sync-kirozhang-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, one per line, e.g. allbirds.com, https://www.brooklinen.com. Paste a collection URL (https://colourpop.com/collections/lips) to track only that collection.",
"items": {
"type": "string"
}
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 1,
"maximum": 25000,
"type": "integer",
"description": "Upper limit of products read per store. Removed products are only detected when the whole catalog fits in this limit.",
"default": 1000
},
"includeVariants": {
"title": "Include variants",
"type": "boolean",
"description": "Add every variant (size / color) with SKU, price, compare-at price and stock status.",
"default": true
},
"includeDescription": {
"title": "Include description",
"type": "boolean",
"description": "Add the product description as plain text.",
"default": false
},
"onlyChanges": {
"title": "Only changed products (monitoring mode)",
"type": "boolean",
"description": "Off by default (the whole catalog is returned, each product with changeTypes since the last run). When on, the first run saves the catalog as a baseline and later runs return – and charge – only products that changed.",
"default": false
},
"changeTypes": {
"title": "Changes to report",
"type": "array",
"description": "Optional. Leave empty to report every type of change.",
"items": {
"type": "string",
"enum": [
"new",
"removed",
"price_drop",
"price_increase",
"discount_started",
"discount_ended",
"back_in_stock",
"sold_out",
"variant_back_in_stock",
"variant_sold_out",
"variant_price",
"variant_added",
"variant_removed",
"title_changed"
],
"enumTitles": [
"New products",
"Removed products",
"Price drops",
"Price increases",
"Discount started (compare-at price)",
"Discount ended",
"Product back in stock",
"Product sold out",
"Variant (size/color) back in stock",
"Variant sold out",
"Variant price changed",
"Variant added",
"Variant removed",
"Product renamed"
]
}
},
"minPriceChangePercent": {
"title": "Minimum price change (%)",
"minimum": 0,
"maximum": 100,
"type": "integer",
"description": "Optional. Ignore price changes smaller than this, e.g. 5."
},
"trackingId": {
"title": "Tracking name",
"type": "string",
"description": "Optional. Runs with the same tracking name compare against each other (default: default). Use different names for different schedules."
},
"slackWebhookUrl": {
"title": "Slack webhook URL",
"type": "string",
"description": "Optional. A Slack Incoming Webhook URL (https://hooks.slack.com/services/…). After a run you get one summary message in that channel. Stored encrypted."
},
"webhookUrl": {
"title": "Webhook URL (JSON)",
"type": "string",
"description": "Optional. Any https endpoint (Make, Zapier, n8n, a Microsoft Teams workflow or your own server). Receives one JSON POST per run with counts, items and the report link. Stored encrypted."
},
"notifyOn": {
"title": "Send a notification when",
"enum": [
"alerts",
"always"
],
"type": "string",
"description": "When the Slack / webhook message is sent.",
"default": "alerts"
},
"publicReport": {
"title": "Shareable report link",
"type": "boolean",
"description": "Off by default. When on, the HTML report (stores, changes, 7- and 30-day trends) is kept at one fixed link per Tracking name (OUTPUT.reportUrl) – share it with your team or a client. Anyone with the link can open it.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Apify Proxy (datacenter) works for most stores. Use residential proxies for stores that block datacenter traffic.",
"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
}
}
}
}
}
}
}
}
}
}