{ "openapi": "3.0.1", "info": { "title": "Shopify Price Tracker: Competitor Price Snapshot", "description": "Track competitor prices on any Shopify store. One snapshot per store: min/median/max prices, price bands by product type and vendor, sale share and discounts, stock, cheapest and newest products, CSV price list, and price drops, new and removed products since your last run.", "version": "0.1", "x-build-id": "CCfzXbJq4NDBFxqoo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blond_terrarium~shopify-competitor-price-snapshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blond_terrarium-shopify-competitor-price-snapshot", "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/blond_terrarium~shopify-competitor-price-snapshot/runs": { "post": { "operationId": "runs-sync-blond_terrarium-shopify-competitor-price-snapshot", "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/blond_terrarium~shopify-competitor-price-snapshot/run-sync": { "post": { "operationId": "run-sync-blond_terrarium-shopify-competitor-price-snapshot", "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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores", "type": "array", "description": "Competitor Shopify stores, custom domains welcome (allbirds.com, https://www.deathwishcoffee.com, store.myshopify.com).", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Products included in each snapshot. One snapshot is charged per started 1,000 products (1-1,000 = 1 snapshot, 1,001-2,000 = 2).", "default": 1000 }, "keyword": { "title": "Only products matching (optional)", "type": "string", "description": "Comma-separated keywords to track just part of a catalog (for example: hoodie, jacket)." }, "compareWithPrevious": { "title": "Show changes since last run", "type": "boolean", "description": "Save each snapshot in a named key-value store in your account and report price drops, increases, new, removed and restocked products next time. Schedule the Actor daily or weekly.", "default": true }, "snapshotStoreName": { "title": "Snapshot history store name", "type": "string", "description": "Named key-value store that keeps the previous snapshots. Use different names for different projects.", "default": "shopify-price-snapshots" }, "listSize": { "title": "Products per top list", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many products to list under cheapest, most expensive, biggest discounts and newest.", "default": 10 }, "savePriceListCsv": { "title": "Save CSV price list", "type": "boolean", "description": "Save a CSV of every product with price, compare-at price, discount and stock per store.", "default": true }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many stores to snapshot at once.", "default": 3 }, "maxChargedSnapshots": { "title": "Max snapshots to charge (0 = no limit)", "minimum": 0, "type": "integer", "description": "Stop after this many charged snapshots. The run also stops at your \"Max cost per run\".", "default": 0 } } }, "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 } } } } } } } } } }