{ "openapi": "3.0.1", "info": { "title": "Shopify & WooCommerce Product Tracker", "description": "Track competitor Shopify and WooCommerce stores: full catalog with prices, discounts, stock, SKUs and images, plus what changed since the last run (new products, price drops and increases, back in stock, out of stock, removed). Public product feeds only, no login.", "version": "0.1", "x-build-id": "GDjZTmtMKCh6VXVV5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/descriptive_orbit~store-product-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-descriptive_orbit-store-product-tracker", "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/descriptive_orbit~store-product-tracker/runs": { "post": { "operationId": "runs-sync-descriptive_orbit-store-product-tracker", "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/descriptive_orbit~store-product-tracker/run-sync": { "post": { "operationId": "run-sync-descriptive_orbit-store-product-tracker", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Store or collection URLs", "type": "array", "description": "Shopify or WooCommerce store home pages (e.g. https://www.allbirds.com), Shopify collection pages (https://store.com/collections/sale) or WooCommerce category pages (https://store.com/product-category/shoes/). The platform is detected automatically. A URL that is neither platform produces one error row and the run carries on with the other stores.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop after this many products per URL. With variants on, all variants of these products are returned. Products that are removed from a store are only detected when the whole catalog fits under this limit.", "default": 1000 }, "includeVariants": { "title": "One row per variant", "type": "boolean", "description": "Off: one row per product with the lowest price (price) and highest price (maxPrice), and available = true if any variant is in stock. On: one row per variant (size, colour...) with its own price, SKU and stock. Variant mode keeps a separate change-tracking snapshot.", "default": false }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Saves a snapshot of each store after the run in a named key-value store, so the next run can mark every row as new, price_drop, price_increase, back_in_stock, out_of_stock, removed or unchanged, with previousPrice and priceChangePct. The first run for a store marks everything as new.", "default": true }, "onlyChanges": { "title": "Output only changes", "type": "boolean", "description": "Only output rows whose changeType is not unchanged, so you pay only for new products, price changes, stock changes and removals. Ideal for scheduled monitoring. Needs change tracking (it is switched on automatically).", "default": false }, "stateStoreName": { "title": "Snapshot store name", "type": "string", "description": "Name of the key-value store that keeps the snapshots between runs. Use a different name to run separate monitors of the same store, or to start a fresh baseline.", "default": "store-product-tracker-state" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Usually not needed: Shopify and WooCommerce product feeds are public. If a store blocks requests (HTTP 403 or 429 in the error row), try Apify Proxy, residential group.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }