{ "openapi": "3.0.1", "info": { "title": "Rakuten Affiliate API - Merchants, Coupons, Products", "description": "Query Rakuten Advertising APIs for affiliate merchants, products, and active coupons. You provide your own OAuth credentials or access token. Multi-network: US/UK/AU/BR/DE. Get merchant IDs, deep-links, commission data.", "version": "1.0", "x-build-id": "ja0b5Q1cy3Qqm6aBM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~rakuten-affiliate-merchants/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-rakuten-affiliate-merchants", "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/viralanalyzer~rakuten-affiliate-merchants/runs": { "post": { "operationId": "runs-sync-viralanalyzer-rakuten-affiliate-merchants", "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/viralanalyzer~rakuten-affiliate-merchants/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-rakuten-affiliate-merchants", "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": { "clientId": { "title": "Client ID (OAuth)", "type": "string", "description": "Your Rakuten Advertising Client ID. Get at developers.rakutenadvertising.com > Applications. Required unless accessToken is provided." }, "clientSecret": { "title": "Client Secret (OAuth)", "type": "string", "description": "Your Rakuten Advertising Client Secret. Required unless accessToken is provided. Keep this confidential." }, "siteId": { "title": "Site ID (Publisher ID)", "type": "string", "description": "Your Rakuten Publisher Site ID (~7 digits, e.g. 4703080). Found in your Rakuten Advertising account." }, "accessToken": { "title": "Pre-generated Access Token (alternative to OAuth)", "type": "string", "description": "OPTIONAL: paste a token from Rakuten Developer Portal 'Generate Token' button. If provided, OAuth flow is skipped. Use this if OAuth client_credentials flow fails." }, "queryType": { "title": "Query Type", "enum": [ "productSearch", "coupons", "advertisers" ], "type": "string", "description": "Which Rakuten endpoint to query", "default": "productSearch" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword (productSearch: matches product name; advertisers: matches merchant name; coupons: matches offer text)" }, "advertiserId": { "title": "Advertiser/Merchant ID (optional)", "type": "string", "description": "Filter results to a specific merchant. Get IDs from queryType=advertisers first.", "default": "" }, "networkId": { "title": "Network ID", "enum": [ "1", "3", "7", "9", "14" ], "type": "string", "description": "Rakuten regional network. 1=US (default), 3=UK, 7=Australia, 9=Brazil, 14=Germany.", "default": "1" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum items to return per query", "default": 25 }, "proxyConfiguration": { "title": "Proxy Configuration (optional)", "type": "object", "description": "Rakuten API is auth-only (no IP-based anti-bot). Proxy unnecessary unless your network blocks Rakuten domains.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }