{ "openapi": "3.0.1", "info": { "title": "Alibaba Supplier Shortlist by Price, MOQ and Trust", "description": "Get a ranked shortlist of Alibaba.com suppliers for each product you name: each supplier scored on price against the market median, fit to your minimum order, Verified, Trade Assurance, years, rating and units sold, with its best offer and the reasons. One price per shortlist.", "version": "0.1", "x-build-id": "pzJGIwq61rjP8VgTH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/v0iddo~alibaba-supplier-shortlist/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-v0iddo-alibaba-supplier-shortlist", "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/v0iddo~alibaba-supplier-shortlist/runs": { "post": { "operationId": "runs-sync-v0iddo-alibaba-supplier-shortlist", "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/v0iddo~alibaba-supplier-shortlist/run-sync": { "post": { "operationId": "run-sync-v0iddo-alibaba-supplier-shortlist", "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": { "searchTerms": { "title": "Products", "type": "array", "description": "Products as a buyer would type them, one per line, for example led strip lights. Each product gets its own shortlist.", "items": { "type": "string" } }, "targetPrice": { "title": "Target price per unit (USD)", "minimum": 0, "type": "number", "description": "The most you want to pay per unit. Suppliers with an offer at or under it come first. Empty: price only counts in the score." }, "targetMOQ": { "title": "Your order size (units)", "minimum": 1, "type": "integer", "description": "How many units you plan to order first. Suppliers whose minimum order is this or less come first. Empty: a smaller minimum order scores higher." }, "shortlistSize": { "title": "Suppliers per shortlist", "minimum": 3, "maximum": 30, "type": "integer", "description": "How many suppliers each product's shortlist names.", "default": 10 }, "maxPages": { "title": "Pages read per product", "minimum": 1, "maximum": 20, "type": "integer", "description": "Alibaba result pages (about 47 offers each) read for each product. More pages, more suppliers to choose from; the price per shortlist stays the same.", "default": 3 }, "supplierCountries": { "title": "Supplier countries", "type": "array", "description": "Only suppliers from these countries: names or codes, for example China, Vietnam, IN, Hong Kong.", "items": { "type": "string" } }, "verifiedSupplier": { "title": "Verified suppliers only", "type": "boolean", "description": "Only suppliers with Alibaba's verified badge.", "default": false }, "tradeAssurance": { "title": "Trade Assurance only", "type": "boolean", "description": "Only suppliers that take Trade Assurance orders.", "default": false }, "minSupplierRating": { "title": "Supplier rating", "enum": [ "any", "4", "4.5", "4.8" ], "type": "string", "description": "Only suppliers rated at least this (out of 5).", "default": "any" }, "certifications": { "title": "Product certifications", "type": "array", "description": "Only offers with any of these certifications, for example CE, RoHS, FCC.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 3000, "type": "integer", "description": "The run stops after this many result rows. It also caps what one run can cost.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave as is: the run starts on the cheapest network the site accepts and switches to Apify Proxy automatically when the site blocks it. Pick proxy groups here only to force one specific network." } } }, "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 } } } } } } } } } }