{ "openapi": "3.0.1", "info": { "title": "Shopify Price & Stock Change Monitor", "description": "Reports only what changed in public Shopify catalogs since the last run: new and removed products, price changes and stock changes.", "version": "0.1", "x-build-id": "BVQ4faLnweqxgBukZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studio_ojeda~shopify-store-price-stock-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studio_ojeda-shopify-store-price-stock-change-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/studio_ojeda~shopify-store-price-stock-change-monitor/runs": { "post": { "operationId": "runs-sync-studio_ojeda-shopify-store-price-stock-change-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/studio_ojeda~shopify-store-price-stock-change-monitor/run-sync": { "post": { "operationId": "run-sync-studio_ojeda-shopify-store-price-stock-change-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": "Store URLs", "maxItems": 1000, "type": "array", "description": "Public Shopify store addresses, https only, for example https://www.example-store.com. Use the store's canonical address; redirects are not followed.", "default": [ "https://www.allbirds.com", "https://www.brooklinen.com" ], "items": { "type": "string" } }, "maxStores": { "title": "Max stores per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Stores beyond this number are skipped with a note.", "default": 25 }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stores with a larger catalog are reported as too large (never partially monitored, which would cause false removals).", "default": 5000 }, "maxPagesPerStore": { "title": "Max catalog pages per store", "minimum": 1, "maximum": 100, "type": "integer", "description": "Each page holds up to 250 products.", "default": 20 }, "minDelaySeconds": { "title": "Delay between requests to the same store (seconds)", "minimum": 1, "type": "number", "description": "Minimum pause between requests to one store. Cannot be lower than 1.", "default": 1 }, "maxChangesPerStore": { "title": "Max change items per store per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety cap on billable items per store per run, for example after a store-wide repricing. Price and stock changes are delivered before new and removed products. Changes beyond the cap are held back and reported on the following runs; none are lost.", "default": 1000 }, "maxCatalogShrinkPercent": { "title": "Suspicious catalog shrink (percent)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Glitch guard. If a store's catalog is suddenly smaller than last time by more than this percentage (for example an empty or maintenance response), nothing is reported and the old data is kept. The smaller catalog is accepted only if the next run sees about the same size (within 10%). 100 turns the guard off.", "default": 50 }, "stateStore": { "title": "State storage", "type": "string", "description": "The key-value store that remembers each store's last catalog so later runs can report only what changed. Pick one (create it under Storage if needed) and keep it the same for every run and schedule. Without it the Actor still runs, but every run starts a fresh baseline and reports no changes." }, "stateStoreName": { "title": "State storage name", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$", "minLength": 3, "maxLength": 63, "type": "string", "description": "Named key-value store holding the last catalog snapshot of each store. Lowercase letters, digits and hyphens. Keep it the same between runs; change it to start over with fresh baselines.", "default": "shopify-price-stock-monitor-state" } } }, "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 } } } } } } } } } }