{ "openapi": "3.0.1", "info": { "title": "Amazon Competitor Offer Matrix", "description": "Turn vendor offer rows you already have into a per-product comparison matrix with one currency, your own fee estimates and clear missing-data warnings.", "version": "0.1", "x-build-id": "ffaeqw7X7ahStk6hK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/practical_ai_lab_jp~pal-amazon-competitor-offer-matrix/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-practical_ai_lab_jp-pal-amazon-competitor-offer-matrix", "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/practical_ai_lab_jp~pal-amazon-competitor-offer-matrix/runs": { "post": { "operationId": "runs-sync-practical_ai_lab_jp-pal-amazon-competitor-offer-matrix", "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/practical_ai_lab_jp~pal-amazon-competitor-offer-matrix/run-sync": { "post": { "operationId": "run-sync-practical_ai_lab_jp-pal-amazon-competitor-offer-matrix", "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": [ "offers" ], "properties": { "offers": { "title": "Offer rows", "type": "array", "description": "Rows you already exported from vendor or product datasets. Each row should have a product id (for example an ASIN) or a title, a vendor name, a price and ideally a currency and shipping cost. Nothing is fetched from any website." }, "targetCurrency": { "title": "Target currency", "type": "string", "description": "Three-letter code all prices are converted into.", "default": "USD" }, "fxRates": { "title": "Exchange rates you supply", "type": "object", "description": "How many units of the target currency one unit of each listed currency is worth, for example {\"EUR\": 1.08}. No rates are downloaded. Offers in a currency without a rate are marked not comparable." }, "defaultCurrency": { "title": "Default currency for rows without one", "type": "string", "description": "Optional. Used when a row has no currency; every use is flagged with a warning." }, "defaultShipping": { "title": "Default shipping (target currency)", "minimum": 0, "type": "number", "description": "Optional. Used when a row has no shipping cost; every use is flagged. If empty, offers without shipping are not ranked." }, "defaultFeePercent": { "title": "Default estimated fee (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Your own estimate of fees as a percentage of item price, applied to vendors not listed below. This is not an official fee schedule.", "default": 0 }, "defaultFeeFixed": { "title": "Default fixed fee per offer (target currency)", "minimum": 0, "type": "number", "description": "Your own estimate of a fixed fee per offer, in the target currency.", "default": 0 }, "vendorFees": { "title": "Fee estimates per vendor", "type": "object", "description": "Optional per-vendor overrides, for example {\"Vendor A\": {\"percent\": 15, \"fixed\": 0.30}}. Vendor names are matched case-insensitively." }, "fieldMap": { "title": "Column name mapping", "type": "object", "description": "Optional. Map your column names to ours, for example {\"price\": \"Buy Box Price\"}. Supported keys: productId, vendor, title, price, currency, shipping, url, availability." }, "maxProducts": { "title": "Maximum products", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit of matrix rows produced. One row per product.", "default": 200 } } }, "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 } } } } } } } } } }