{ "openapi": "3.0.1", "info": { "title": "Shopify Store Products & Price Change Monitor", "description": "Export all products, variants, prices, stock and SKUs from any Shopify store, and monitor competitors for price drops, price increases, new products, back-in-stock and sold-out changes.", "version": "1.0", "x-build-id": "DsO5wktWKfQNpEmLI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mersetti~shopify-products-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mersetti-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/mersetti~shopify-products-monitor/runs": { "post": { "operationId": "runs-sync-mersetti-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/mersetti~shopify-products-monitor/run-sync": { "post": { "operationId": "run-sync-mersetti-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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores", "type": "array", "description": "Store URLs or domains. Any page of the store works (https://www.allbirds.com, allbirds.com, weareallbirds.myshopify.com). A collection URL (https://www.allbirds.com/collections/mens) limits the run to that collection.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Maximum number of products (after keyword filter) read from each store or collection. Shopify serves at most 25,000 products per store this way.", "default": 1000 }, "outputLevel": { "title": "Output level", "enum": [ "variant", "product" ], "type": "string", "description": "\"variant\": one row per variant (size/color) with its own SKU, price and stock. \"product\": one row per product with min/max price and availability across variants.", "default": "variant" }, "includeDescription": { "title": "Include product description", "type": "boolean", "description": "Adds the plain-text product description (descriptionText). No extra requests.", "default": false }, "keywords": { "title": "Keywords (any match)", "type": "array", "description": "Keep products whose title, product type, vendor or tags contain ANY of these words (case-insensitive). Empty = all products.", "items": { "type": "string" } }, "onlyAvailable": { "title": "Only in-stock items", "type": "boolean", "description": "Output only variants (or products) that are currently available. In monitor mode, out-of-stock events are still reported.", "default": false }, "monitorMode": { "title": "Monitor mode (only changes)", "type": "boolean", "description": "Remembers prices and stock between runs and outputs only changes: new products, price drops/increases, back in stock, out of stock and (optionally) removed products. Schedule the Actor (e.g. daily) to get a change feed. You pay only for changes.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Name of the saved state. Use different IDs for different watchlists.", "default": "default" }, "baselineOnFirstRun": { "title": "Silent first run", "type": "boolean", "description": "The first time a store is monitored, only save its current catalog (no output, no cost), so later runs report real changes. Applies to stores added to an existing monitor, too.", "default": true }, "reportNewProducts": { "title": "Report new products", "type": "boolean", "description": "Output items not seen in previous runs (changeType = new).", "default": true }, "reportPriceDrops": { "title": "Report price drops", "type": "boolean", "description": "Output items whose price went down (changeType = priceDrop).", "default": true }, "reportPriceIncreases": { "title": "Report price increases", "type": "boolean", "description": "Output items whose price went up (changeType = priceIncrease).", "default": true }, "reportBackInStock": { "title": "Report back in stock", "type": "boolean", "description": "Output items that became available again (changeType = backInStock).", "default": true }, "reportOutOfStock": { "title": "Report out of stock", "type": "boolean", "description": "Output items that sold out (changeType = outOfStock).", "default": true }, "reportRemoved": { "title": "Report removed products", "type": "boolean", "description": "Output items that disappeared from the store since the previous run (changeType = removed). Only stores that were read completely are checked.", "default": 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 } } } } } } } } } }