{ "openapi": "3.0.1", "info": { "title": "Shopee Product Detail", "description": "Give it Shopee product URLs, get full product detail back: name, description, price, variants/SKUs, full image gallery, seller info, reviews, ratings. Supports Brazil, Indonesia, Thailand, Malaysia, Singapore, Philippines, Vietnam, Mexico.", "version": "0.0", "x-build-id": "kBsP2zqxqf1PB4srA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gio21~shopee-product-detail/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gio21-shopee-product-detail", "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/gio21~shopee-product-detail/runs": { "post": { "operationId": "runs-sync-gio21-shopee-product-detail", "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/gio21~shopee-product-detail/run-sync": { "post": { "operationId": "run-sync-gio21-shopee-product-detail", "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": [ "productUrls" ], "properties": { "productUrls": { "title": "Product URLs", "uniqueItems": true, "type": "array", "description": "List of Shopee product URLs. Accepts BOTH formats: the canonical 'https://shopee.com.br/-i.SHOPID.ITEMID' and the newer 'https://shopee.com.br/product/SHOPID/ITEMID'. Each URL returns ONE product record with full PDP data (description, variants, images, seller, reviews).", "items": { "type": "string" } }, "country": { "title": "Country (optional override)", "enum": [ "", "BR", "ID", "TH", "MY", "SG", "PH", "VN", "MX" ], "type": "string", "description": "Leave empty to auto-detect the Shopee domain from each URL (recommended). Only set this to force a specific domain for all URLs." }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "When ON, fetches the reviews Shopee exposes for the product, sorted newest-first, each with date, rating, author, comment text and photos. Also adds review-velocity fields: reviewsLast30Days, reviewsAccessible, reviewsComplete, newestReviewDate, oldestReviewDate. Note: Shopee's review API caps at a few hundred reviews per item, so for very high-volume products the velocity figures are a lower bound (reviewsComplete=false). Adds a few extra API calls per product.", "default": false }, "reviewsLimit": { "title": "Max reviews returned", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many of the newest reviews to include in the output array (default 30, max 500). Velocity stats are computed from all reachable reviews regardless of this limit. Only used when 'Include reviews' is ON.", "default": 30 }, "pdpViaPage": { "title": "Reliable mode (recommended)", "type": "boolean", "description": "Loads the real Shopee product page so the data request carries valid anti-bot tokens, then captures it. This is the reliable method and should stay ON. Turning it OFF uses a faster direct API call that Shopee frequently blocks.", "default": true }, "debug": { "title": "Debug logs", "type": "boolean", "description": "Enable verbose logging.", "default": 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 } } } } } } } } } }