{ "openapi": "3.0.1", "info": { "title": "Brand Price & Stock Monitor (Shopify + Product JSON-LD)", "description": "Enter product page URLs, get each variant's price, currency, stock status and the change since your last run as flat JSON. For public Shopify stores and pages with Product JSON-LD. No browser, no proxy. Pay per URL checked; failed URLs are free.", "version": "0.2", "x-build-id": "mFeq6Lj0Sg6xVO5Tg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magenta_courser~brand-price-stock-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magenta_courser-brand-price-stock-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/magenta_courser~brand-price-stock-monitor/runs": { "post": { "operationId": "runs-sync-magenta_courser-brand-price-stock-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/magenta_courser~brand-price-stock-monitor/run-sync": { "post": { "operationId": "run-sync-magenta_courser-brand-price-stock-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": [ "products" ], "properties": { "products": { "title": "Product page URLs", "type": "array", "description": "Public product pages to check, up to 100 per run. Each item is a URL string or an object: {\"url\": \"https://...\", \"productCode\": \"your own label that links the same product across stores\", \"variantId\": \"one variant only\", \"adapter\": \"auto | jsonld | shopify\"}. Works for Shopify storefronts and pages that publish Product JSON-LD." }, "historyStoreName": { "title": "History name (turns on change tracking)", "type": "string", "description": "Name of a key-value store in your account that remembers the last saved price and stock of every variant, for example \"my-brand-prices\". With it, each row gets isNew, isChanged, previousPrice and priceChange. Leave empty for an independent snapshot. Use one name per product list and do not run two runs with the same name at the same time." }, "onlyChanges": { "title": "Save only new or changed rows", "type": "boolean", "description": "Needs a history name. Rows that are identical to the last saved observation are skipped, so a run can save zero rows. Every URL that was checked successfully is still counted (and charged) as one check.", "default": false }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop saving after this many rows (one row per variant).", "default": 1000 }, "maxRequests": { "title": "Maximum HTTP requests", "minimum": 1, "maximum": 1000, "type": "integer", "description": "A URL needs 1 request (JSON-LD) or 2 (Shopify); redirects count too. URLs that do not fit are reported as budgetLimited and are not charged.", "default": 300 }, "maxRunSeconds": { "title": "Time budget (seconds)", "minimum": 10, "maximum": 1800, "type": "integer", "description": "URLs not reached within this time are reported as budgetLimited and are not charged.", "default": 600 }, "requestIntervalMs": { "title": "Pause between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Minimum time between two requests. Keep it at 1000 or more when many URLs are on the same store.", "default": 1000 } } }, "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 } } } } } } } } } }