{ "openapi": "3.0.1", "info": { "title": "Amazon Product Advertising API", "description": "Interact with Amazon Product Advertising API to search products, get item details, and retrieve variations", "version": "1.0", "x-build-id": "u5s4P5tkheUbgpE7A" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/experthasan~amazon-product-advertising-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-experthasan-amazon-product-advertising-api", "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/experthasan~amazon-product-advertising-api/runs": { "post": { "operationId": "runs-sync-experthasan-amazon-product-advertising-api", "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/experthasan~amazon-product-advertising-api/run-sync": { "post": { "operationId": "run-sync-experthasan-amazon-product-advertising-api", "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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "GetVariations", "GetItems", "SearchItems" ], "type": "string", "description": "Select the PA-API operation.", "default": "GetVariations" }, "asin": { "title": "ASIN", "type": "string", "description": "Required for GetVariations." }, "itemIds": { "title": "Item IDs (ASINs)", "type": "array", "description": "Required for GetItems. List of ASINs.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "string", "description": "Required for SearchItems." }, "marketplace": { "title": "Marketplace", "enum": [ "www.amazon.com", "www.amazon.co.uk", "www.amazon.de", "www.amazon.fr", "www.amazon.co.jp", "www.amazon.ca", "www.amazon.it", "www.amazon.es", "www.amazon.in", "www.amazon.nl", "www.amazon.pl", "www.amazon.se", "www.amazon.sg", "www.amazon.com.mx", "www.amazon.com.au", "www.amazon.ae", "www.amazon.com.br", "www.amazon.com.tr", "www.amazon.sa", "www.amazon.eg", "www.amazon.com.be", "www.amazon.ie" ], "type": "string", "description": "The Amazon marketplace to query.", "default": "www.amazon.com" }, "resources": { "title": "Resources (Optional)", "type": "array", "description": "List of resources to retrieve. If empty, retrieves all available resources.", "items": { "type": "string" } }, "searchIndex": { "title": "Search Index", "type": "string", "description": "Target category for SearchItems (e.g., 'Electronics', 'All')." }, "itemCount": { "title": "Item Count", "type": "integer", "description": "Number of items to return (1-10)." }, "itemPage": { "title": "Item Page", "type": "integer", "description": "Page number of results to return (1-10)." }, "variationCount": { "title": "Variation Count", "type": "integer", "description": "Number of variations to return (1-10). For GetVariations." }, "variationPage": { "title": "Variation Page", "type": "integer", "description": "Page number of variations (1-10). For GetVariations." }, "sortBy": { "title": "Sort By", "enum": [ "Relevance", "Price:LowToHigh", "Price:HighToLow", "AvgCustomerReviews", "NewestArrivals", "Featured" ], "type": "string", "description": "Sort order.", "default": "Relevance" }, "prime": { "title": "Prime Eligible", "type": "boolean", "description": "Filter for Prime eligible items." }, "deliveryFlags": { "title": "Delivery Flags", "type": "array", "description": "Filter by delivery flags (e.g., 'Prime', 'FreeShipping').", "items": { "type": "string" } }, "condition": { "title": "Condition", "enum": [ "Any", "New", "Used", "Collectible", "Refurbished" ], "type": "string", "description": "Filter by item condition.", "default": "Any" }, "minPrice": { "title": "Min Price", "type": "integer", "description": "Minimum price in smallest currency unit (e.g. 100 = $1.00)." }, "maxPrice": { "title": "Max Price", "type": "integer", "description": "Maximum price in smallest currency unit." }, "brand": { "title": "Brand", "type": "string", "description": "Filter by brand." }, "minReviewsRating": { "title": "Min Reviews Rating", "type": "integer", "description": "Minimum review rating (0-5)." }, "minSavingPercent": { "title": "Min Saving Percent", "type": "integer", "description": "Minimum saving percentage." }, "offerCount": { "title": "Offer Count", "type": "integer", "description": "Number of offers to retrieve per item." }, "currencyOfPreference": { "title": "Currency of Preference", "type": "string", "description": "Currency for price information (e.g., 'USD')." }, "languagesOfPreference": { "title": "Languages of Preference", "type": "array", "description": "List of languages for localized info (e.g., ['en_US']).", "items": { "type": "string" } }, "availability": { "title": "Availability", "enum": [ "Available", "IncludeOutOfStock" ], "type": "string", "description": "Item availability filter." }, "title": { "title": "Title", "type": "string", "description": "Filter by title." }, "apiParameters": { "title": "Additional API Parameters (JSON)", "type": "object", "description": "Additional parameters for the Amazon API not covered above.", "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 } } } } } } } } } }