{ "openapi": "3.0.1", "info": { "title": "Shopify Catalog Monitor & Price Tracker — Products Scraper", "description": "Scrape any public Shopify store's full catalog (every variant with price, compare-at price, availability, SKU, images) from its products.json, or monitor it and get price, stock and new/removed product change events. $0.0007 per product/variant, $0.0005 per change.", "version": "0.1", "x-build-id": "bUk7DXrlJluyQtQfd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/owlabee~shopify-catalog-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-owlabee-shopify-catalog-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/owlabee~shopify-catalog-monitor/runs": { "post": { "operationId": "runs-sync-owlabee-shopify-catalog-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/owlabee~shopify-catalog-monitor/run-sync": { "post": { "operationId": "run-sync-owlabee-shopify-catalog-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": "Shopify store URLs", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Stores to scrape, one per line. Bare domains (allbirds.com) or any URL on the store (https://www.allbirds.com/collections/mens) both work; each is reduced to the store origin. Stores that are not Shopify, are password-protected or block datacenter traffic produce one error item instead of failing the run.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "`snapshot` writes the current catalog (one record per variant or product). `changes` compares the catalog with the snapshot saved by the previous run in the state store and writes only change records (price, availability, title, new/removed products and variants). The first `changes` run for a store has nothing to compare against and writes the full catalog as `baseline` records.", "default": "snapshot" }, "granularity": { "title": "Granularity", "enum": [ "variant", "product" ], "type": "string", "description": "`variant` (default) emits one record per variant with its own price, SKU and availability. `product` emits one record per product with the lowest variant price, price range, variant count and any-variant availability.", "default": "variant" }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop paginating a store after this many products (250 products per request). Use it with the run's maximum cost to cap spend. When the cap is hit in `changes` mode, removed-product/removed-variant events are suppressed for that store because the listing was incomplete.", "default": 5000 }, "includeCollections": { "title": "Include collection membership", "type": "boolean", "description": "Also read /collections.json and each collection's products.json (up to 100 collections) and add a `collections` array of collection handles to every record. Costs one extra request per collection page; off by default.", "default": false }, "maxSecondsPerStore": { "title": "Max seconds per store", "minimum": 30, "maximum": 7200, "type": "integer", "description": "Time budget for one store, collections included. When it runs out, or when no page arrived for 60 seconds, paging stops and the pages already fetched are kept (and charged as usual); the store is then treated like a truncated listing, so no removals are reported and, in `changes` mode, the saved snapshot keeps the products that were not reached. Collection membership that did not finish is left empty.", "default": 900 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that keeps the last snapshot per store for `changes` mode. Use different names to run independent monitors on the same store; delete a key to re-baseline.", "default": "shopify-catalog-monitor-state" }, "webhookUrl": { "title": "Webhook URL (optional)", "pattern": "^https?://.+", "type": "string", "description": "If set, the Actor POSTs a JSON summary of the run (per-store counts, change counts by type and up to 200 change records) to this URL when it finishes. Delivery failures are logged, never fatal." } } }, "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 } } } } } } } } } }