{ "openapi": "3.0.1", "info": { "title": "Shopify Public Catalog Map & Promo Watch", "description": "Unofficially map user-supplied public Shopify storefront catalogs and detect source-linked promo, collection, and catalog map changes.", "version": "0.1", "x-build-id": "5eBoSVn1RT9dfDQL3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~shopify-public-catalog-map-promo-watch-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-shopify-public-catalog-map-promo-watch-scraper", "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/taroyamada~shopify-public-catalog-map-promo-watch-scraper/runs": { "post": { "operationId": "runs-sync-taroyamada-shopify-public-catalog-map-promo-watch-scraper", "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/taroyamada~shopify-public-catalog-map-promo-watch-scraper/run-sync": { "post": { "operationId": "run-sync-taroyamada-shopify-public-catalog-map-promo-watch-scraper", "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": { "storeDomains": { "title": "Store domains", "type": "array", "description": "User-supplied public Shopify storefront domains.", "items": { "type": "string" }, "default": [ "example.myshopify.com" ] }, "collectionHandles": { "title": "Collection handles", "type": "array", "description": "Optional public collection handles to include.", "items": { "type": "string" }, "default": [] }, "promoKeywords": { "title": "Promo keywords", "type": "array", "description": "Terms used to flag public sale and promo text.", "items": { "type": "string" }, "default": [ "sale", "discount", "clearance", "bundle", "limited time" ] }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum public products to load from each storefront.", "default": 100 }, "emitBaselineSummary": { "title": "Emit baseline summary", "type": "boolean", "description": "Emit a baseline summary row on the first run for a new snapshot namespace.", "default": true }, "emitProductRows": { "title": "Emit product map rows", "type": "boolean", "description": "Emit optional public product map item rows. Off by default; signal rows carry the business value.", "default": false }, "generateReport": { "title": "Generate promo report", "type": "boolean", "description": "Generate a report row when report-worthy rows are emitted.", "default": true }, "authorizedUseConfirmed": { "title": "Authorized use confirmed", "type": "boolean", "description": "Required for non-dry runs. Confirms each storefront is owned by you or authorized by the merchant.", "default": false }, "emitUnchanged": { "title": "Emit unchanged rows", "type": "boolean", "description": "When false, unchanged stores emit no dataset rows and no charges.", "default": false }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "When true, emit sample rows without live calls or billing.", "default": true }, "initialRunMode": { "title": "Initial run mode", "enum": [ "emit_backfill", "baseline_only" ], "type": "string", "description": "Deployment canary control used by automation; emit_backfill allows first-run proof rows, baseline_only is used for no-change proof.", "default": "emit_backfill" }, "snapshotKey": { "title": "Snapshot key", "type": "string", "description": "Optional state namespace for canary and recurring no-change proof runs.", "default": "" } } }, "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 } } } } } } } } } }