{ "openapi": "3.0.1", "info": { "title": "Retail Merchandising Opportunity Agent", "description": "Finds catalog gaps, pricing checks, markdowns, content fixes, and stock opportunities from public retail catalog data.", "version": "0.1", "x-build-id": "shmaC1cjHx6GfZGdN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/k0nkupa~retail-merchandising-opportunity-agent/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-k0nkupa-retail-merchandising-opportunity-agent", "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/k0nkupa~retail-merchandising-opportunity-agent/runs": { "post": { "operationId": "runs-sync-k0nkupa-retail-merchandising-opportunity-agent", "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/k0nkupa~retail-merchandising-opportunity-agent/run-sync": { "post": { "operationId": "run-sync-k0nkupa-retail-merchandising-opportunity-agent", "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": [ "ownStoreUrl", "competitorStoreUrls" ], "properties": { "ownStoreUrl": { "title": "Own store URL", "type": "string", "description": "Reference Shopify storefront URL. The Actor compares competitors against this catalog." }, "competitorStoreUrls": { "title": "Competitor store URLs", "type": "array", "description": "Competitor Shopify storefront URLs to compare against the own store.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional keywords used to flag important product or category gaps.", "items": { "type": "string" } }, "focusCategories": { "title": "Focus categories", "type": "array", "description": "Optional categories or category-like terms used to focus merchandising actions.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of products to fetch from each Shopify catalog.", "default": 250 }, "matchThreshold": { "title": "Match threshold", "minimum": 0, "maximum": 1, "type": "number", "description": "Score from 0 to 1. Competitor products below this score are reported as gaps.", "default": 0.45 }, "priceDeltaThresholdPct": { "title": "Price delta threshold percent", "minimum": 1, "maximum": 100, "type": "integer", "description": "Minimum percent difference before a matched product becomes a pricing action.", "default": 15 }, "includeMatchedProducts": { "title": "Include matched products", "type": "boolean", "description": "When enabled, include competitor products that appear covered by the own catalog.", "default": false }, "includeSummary": { "title": "Include summary rows", "type": "boolean", "description": "Emit one summary row per competitor store.", "default": true }, "currency": { "title": "Currency", "type": "string", "description": "Currency code used to label prices. Shopify products.json prices do not include currency.", "default": "NZD" }, "runMode": { "title": "Run mode", "enum": [ "standard", "ai" ], "type": "string", "description": "Use standard for deterministic rows only, or ai for optional AI summaries and drafts.", "default": "standard" }, "aiApiKey": { "title": "AI API key", "type": "string", "description": "Optional OpenAI-compatible API key. Required only when run mode is ai." }, "aiBaseUrl": { "title": "AI base URL", "type": "string", "description": "OpenAI-compatible base URL.", "default": "https://api.openai.com/v1" }, "aiModel": { "title": "AI model", "type": "string", "description": "OpenAI-compatible chat model name.", "default": "gpt-4.1-mini" }, "aiMaxRows": { "title": "AI max rows", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of ready action rows to enrich with AI in one run.", "default": 25 } } }, "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 } } } } } } } } } }