{ "openapi": "3.0.1", "info": { "title": "Shopee Campaign Microsite Scraper", "description": "Scrape products from Shopee campaign microsites (/m/{slug}). Discover active campaigns automatically from the homepage, or scrape a specific campaign by slug. Handles both card-grid layouts (full data) and editorial link grids (ID-based with optional detail enrichment).", "version": "0.1", "x-build-id": "Yb6aTS0vY6ueT6Bzf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~shopee-campaign/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-shopee-campaign", "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/xtracto~shopee-campaign/runs": { "post": { "operationId": "runs-sync-xtracto-shopee-campaign", "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/xtracto~shopee-campaign/run-sync": { "post": { "operationId": "run-sync-xtracto-shopee-campaign", "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": { "mode": { "title": "Mode", "enum": [ "scrape", "discover" ], "type": "string", "description": "scrape: Fetch products from a specific campaign page (requires slug or url). discover: List all active campaign slugs currently visible on the Shopee homepage — useful to find what campaigns are running right now.", "default": "scrape" }, "slug": { "title": "Campaign slug", "type": "string", "description": "The campaign slug from the /m/{slug} URL. Example: 'shopee-fitcheck'. Required for mode=scrape unless url is provided. Use mode=discover to find active slugs automatically." }, "url": { "title": "Campaign URL (alternative to slug)", "type": "string", "description": "Full campaign microsite URL. The slug is extracted automatically. Example: https://shopee.co.id/m/shopee-fitcheck" }, "country": { "title": "Country", "enum": [ "id", "sg", "my", "th", "ph", "vn", "br", "tw", "mx", "co", "cl" ], "type": "string", "description": "Shopee regional site. Campaign microsites are most active and varied on shopee.co.id (Indonesia). Other countries may have fewer campaigns.", "default": "id" }, "maxProducts": { "title": "Max products", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum products to return. For card-grid campaigns (Type A), all available cards are returned up to this limit. For editorial link-grid campaigns (Type B), this limits how many product links are enriched when fetchDetail is enabled.", "default": 25 }, "fetchDetail": { "title": "Fetch full product detail", "type": "boolean", "description": "For editorial link-grid campaigns (Type B, e.g. Pilih Lokal, Barokah): fetch full product data — name, price, images, description, seller info — for each product link. Without this, only shop_id, item_id, and URL are returned for Type B. Card-grid campaigns (Type A) always include name and price regardless of this setting.", "default": false }, "delay": { "title": "Request delay (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "Delay between HTTP requests in seconds.", "default": 1 } } }, "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 } } } } } } } } } }