{ "openapi": "3.0.1", "info": { "title": "Shopify New Product Monitor - Competitor Launches", "description": "Watch any Shopify store on a schedule and get only the products it launched recently. Remembers what it already reported between runs, so a daily schedule alerts you once per product instead of resending the whole catalogue. Scanning is free - you pay only for new arrivals.", "version": "0.1", "x-build-id": "rKUJJPN5wjG30IeTX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gganbukim~shopify-new-arrivals-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gganbukim-shopify-new-arrivals-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/gganbukim~shopify-new-arrivals-monitor/runs": { "post": { "operationId": "runs-sync-gganbukim-shopify-new-arrivals-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/gganbukim~shopify-new-arrivals-monitor/run-sync": { "post": { "operationId": "run-sync-gganbukim-shopify-new-arrivals-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 stores to watch", "type": "array", "description": "Bare domains or any URL on the store. Watch as many competitors as you like in one scheduled run.", "items": { "type": "string" } }, "withinDays": { "title": "Consider new if launched within (days)", "minimum": 1, "type": "integer", "description": "Products older than this are ignored. For a daily schedule, 7 is a sensible window — it covers a missed run without flooding you.", "default": 30 }, "dateField": { "title": "Date to judge by", "enum": [ "published_at", "created_at" ], "type": "string", "description": "published_at is when the store made it visible to shoppers. created_at is when it was first added, which can be much earlier for planned drops.", "default": "published_at" }, "onlyUnseen": { "title": "Only report products not seen before", "type": "boolean", "description": "Remembers reported product IDs between runs, so a schedule alerts you once per product. Turn off to always emit everything in the window.", "default": true }, "memoryStoreName": { "title": "Memory store name", "type": "string", "description": "Named key-value store holding the IDs already reported. Change it to run two independent watchlists, or clear that store in the Console to start alerting from scratch.", "default": "shopify-new-arrivals-seen" }, "onSaleOnly": { "title": "Only new products already discounted", "type": "boolean", "description": "Narrow to launches that arrived with a compare-at markdown.", "default": false }, "maxProductsScanned": { "title": "Max products scanned per store", "minimum": 250, "type": "integer", "description": "The catalogue is read to find recent items. Raise for very large stores, lower to cut cost. You are only billed for the new products reported, never for scanning.", "default": 2000 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Stores processed in parallel. Raise it when watching many competitors at once.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave the default.", "default": { "useApifyProxy": true } } } }, "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 } } }, "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 } } } } } } } } } }