{ "openapi": "3.0.1", "info": { "title": "Shopify Variant Stock & Price Change Feed", "description": "Recheck public variant price and availability changes; do not infer private stock quantities. For Shopify category and inventory monitoring teams. Check the live Pricing tab and input limits.", "version": "0.1", "x-build-id": "H3pMeSGxbgMESVE7Q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/practical_ai_lab_jp~pal-shopify-variant-stock-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-practical_ai_lab_jp-pal-shopify-variant-stock-feed", "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/practical_ai_lab_jp~pal-shopify-variant-stock-feed/runs": { "post": { "operationId": "runs-sync-practical_ai_lab_jp-pal-shopify-variant-stock-feed", "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/practical_ai_lab_jp~pal-shopify-variant-stock-feed/run-sync": { "post": { "operationId": "run-sync-practical_ai_lab_jp-pal-shopify-variant-stock-feed", "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": "Shopify store URLs", "minItems": 1, "maxItems": 10, "type": "array", "description": "HTTPS addresses of Shopify stores (up to 10). Only the domain is used; any path is ignored. Replace the sample with stores you are allowed to monitor.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper bound of products read per store (each product can have several variants). Keeps runs small and cheap.", "default": 250 }, "collectionHandle": { "title": "Collection handle (optional)", "type": "string", "description": "Read only one collection, for example 'new-arrivals'. Applies to every store in the list. Leave empty for the whole catalog." }, "availabilityFilter": { "title": "Availability filter", "enum": [ "all", "available", "sold_out" ], "type": "string", "description": "Which variants appear in the output. Change detection still sees all variants.", "default": "all" }, "minPrice": { "title": "Minimum price (optional)", "minimum": 0, "type": "number", "description": "Skip variants priced below this value (in the store's own currency, which the feed does not state)." }, "maxPrice": { "title": "Maximum price (optional)", "minimum": 0, "type": "number", "description": "Skip variants priced above this value (in the store's own currency)." }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Compare with the previous run of the same store and scope, using a small snapshot saved in a named key-value store. The first run is a baseline.", "default": true }, "onlyChangedRecords": { "title": "Output only changed variants", "type": "boolean", "description": "Output only variants with a new price, new availability, or that are new. Requires change tracking. The baseline run outputs nothing in this mode.", "default": false }, "minPriceDropPercent": { "title": "Minimum meaningful price drop (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Flag a price-drop signal only when the published price decreased at least this percent since the last stored snapshot. Set 0 for any decrease. Baseline has no alert signal.", "default": 5 }, "onlyActionableChanges": { "title": "Output only price drops or restocks", "type": "boolean", "description": "If enabled, output rows only when priceDropPercent meets the threshold or a published sold-out variant becomes available. Baseline outputs no rows; no emails are sent.", "default": false }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Minimum pause between requests to a store. A longer Crawl-delay in robots.txt takes precedence (up to 10 seconds).", "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 } } } } } } } } } }