{ "openapi": "3.0.1", "info": { "title": "Shopify Store Products & Price Monitor: Prices, Stock, Variants", "description": "Get every product, price, variant and stock flag from any Shopify store's public catalog, or run it on a schedule to see only what changed: new products, price drops, price rises, out of stock, back in stock and removed items. No login, no browser.", "version": "0.0", "x-build-id": "jsL4Gmw1JDIxjak9L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/charlesmarkette~shopify-store-products-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-charlesmarkette-shopify-store-products-price-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/charlesmarkette~shopify-store-products-price-monitor/runs": { "post": { "operationId": "runs-sync-charlesmarkette-shopify-store-products-price-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/charlesmarkette~shopify-store-products-price-monitor/run-sync": { "post": { "operationId": "run-sync-charlesmarkette-shopify-store-products-price-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", "properties": { "startUrls": { "title": "Store URLs", "type": "array", "description": "One per line. A Shopify store's home page (https://shop.example.com), a bare domain (shop.example.com) or a collection URL (https://shop.example.com/collections/sale) to read only that collection. The store's public products feed (/products.json) is read; no login, no cart or checkout.", "items": { "type": "string" } }, "datasetId": { "title": "Dataset of store URLs", "type": "string", "description": "Optional. A dataset whose items hold store URLs or domains (for example from a tech-stack or Google Maps run). Each item's store is read like the URLs above. Use {{resource.defaultDatasetId}} in an integration." }, "urlField": { "title": "URL field", "type": "string", "description": "The item field that holds the store URL or domain. Dotted paths work (company.website). Default: the first of url, website, domain, storeUrl that has a value." }, "outputMode": { "title": "Output", "enum": [ "products", "variants" ], "type": "string", "description": "Products: one row per product, with its variants in a nested list. Variants: one row per variant (size, colour…) with the product's fields copied onto it, which is easier in spreadsheets. Each row is charged either way.", "default": "products" }, "includeBodyText": { "title": "Include description text", "type": "boolean", "description": "Add the product description as plain text (HTML tags removed, up to 20,000 characters). Turn off for smaller rows.", "default": true }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop reading a store (or collection) after this many products. In monitor mode, a store cut off by this limit gets no 'removed' rows, because the products after the limit weren't seen.", "default": 1000 }, "maxResults": { "title": "Max output rows", "minimum": 1, "type": "integer", "description": "Optional cap on output rows across all stores (products, variant rows or change rows)." }, "onlyChanges": { "title": "Only changes since the last run (monitor)", "type": "boolean", "description": "Remember each product between runs and output only products that are new, dropped or raised their price, came back in stock, sold out, or changed title or variant count, plus 'removed' rows for products that disappeared. The first run outputs every product as 'new'. Schedule it daily for price and stock alerts.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional. Names the memory used by monitor mode, so you can add or remove stores without losing what was remembered for the others, or keep separate monitors for the same stores. Empty: the memory is tied to the exact list of stores." }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Pause between two requests to the same store. Each store gets one request at a time; up to 3 different stores are read in parallel.", "default": 500 } } }, "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 } } } } } } } } } }