https://claw-callback.nexscope.ai/api/skill-api/v1/skills/ebay-search/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.nexscope.ai/api/skill-api/v1/skills/ebay-search/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | optional | Search keyword, max 1024 characters Example: phone case |
ebayDomain | string | optional | eBay site domain, default ebay.com. Options: ebay.com (United States), ebay.co.uk (United Kingdom), ebay.de (Germany), ebay.fr (France), ebay.it (Italy), ebay.es (Spain), ebay.ca (Canada), ebay.com.au (Australia), ebay.nl (Netherlands), ebay.at (Austria), ebay.ch (Switzerland), ebay.pl (Poland), ebay.ie (Ireland), ebay.com.hk (Hong Kong, China), ebay.com.my (Malaysia), ebay.com.sg (Singapore) |
page | integer | optional | Page number for pagination, default 1 Example: 1 |
pageSize | integer | optional | Maximum results per page, default 50. Options: 25, 50, 100, 200 Example: 10 |
orderBy | string | optional | Sort order, default 12 (Best Match). Options: 1 (Ending soonest), 2 (Price lowest), 3 (Price highest), 7 (Distance nearest), 10 (Newly listed), 12 (Best Match), 15 (Price + shipping lowest), 16 (Price + shipping highest), 18 (New first), 19 (Used first) |
priceMin | number | optional | Minimum price filter Example: 1 |
priceMax | number | optional | Maximum price filter Example: 1 |
itemCondition | string | optional | Item condition code, multiple separated by \ |
buyingFormat | string | optional | Buying format. Options: Auction, BIN (Buy It Now), BO (Best Offer) |
showOnly | string | optional | Filter conditions, comma-separated for multiple values. Options: Complete (Ended), Sold (Sold), FR (Free returns), RPA (Returns accepted), AS (Authorized seller), Savings (Discounts), SaleItems (Sale items), Lots (Lots), Charity (Charity), AV, FS (Free shipping), LPickup (Local pickup) |
location | integer | optional | Country/region code of item location (e.g., 1=United States, 2=Canada, 3=United Kingdom, 45=China, 77=Germany) Example: 1 |
prefLoc | string | optional | Preferred location scope. Options: 1 (Domestic), 2 (Regional), 3 (Worldwide) |
zipCode | string | optional | ZIP or postal code for filtering shippable items by region |
categoryId | integer | optional | eBay category ID for category-specific search Example: 1 |
noCache | boolean | optional | Whether to bypass cache, default false Example: false |
Request example
{
"keyword": "phone case",
"pageSize": 10,
"page": 1
}Response body
Returns the documented upstream API response directly without an additional wrapper.
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Total matching results Example: 1 |
products | array | optional | Product list array (see product fields below) Example: [] |
columns | array | optional | Rendered column definitions Example: [] |
type | string | optional | Render style identifier |
costToken | integer | optional | Token consumption Example: 1 |
products[].productId | string | optional | eBay product ID Example: example-id |
products[].title | string | optional | Product title |
products[].subtitle | string | optional | Product subtitle |
products[].price | number | optional | Current price / transaction price Example: 1 |
products[].minPrice | number | optional | Price range start value (for multi-SKU items) Example: 1 |
products[].maxPrice | number | optional | Price range end value (for multi-SKU items) Example: 1 |
products[].oldPrice | number | optional | Original price before discount Example: 1 |
products[].currency | string | optional | Currency unit (e.g., USD, GBP, EUR) |
products[].condition | string | optional | Item condition description |
products[].link | string | optional | eBay product detail page link |
products[].imageUrl | string | optional | Product thumbnail URL Example: https://example.com/image.jpg |
products[].shipping | string | optional | Shipping information |
products[].location | string | optional | Item location |
products[].sellerName | string | optional | Seller name |
products[].sellerReviews | integer | optional | Seller feedback count Example: 1 |
products[].positiveFeedbackInPercentage | number | optional | Seller positive feedback percentage Example: 1 |
products[].salesQuantity | integer | optional | Quantity sold Example: 1 |
products[].bidsCount | integer | optional | Bid count (for auction items) Example: 1 |
products[].returns | string | optional | Return information |
products[].promotion | string | optional | Promotion information |
products[].sponsored | boolean | optional | Whether sponsored/promoted item Example: false |
products[].sourceType | string | optional | Source platform identifier (ebay) |
products[].sourceTool | string | optional | Source tool identifier |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
title | string | optional | Provider-specific response title. |
sourceType | string | optional | Provider-specific source platform type. |
sourceTool | string | optional | Provider-specific source tool name. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"total": 1,
"products": [
{
"productId": "example-id",
"price": 1,
"minPrice": 1,
"maxPrice": 1,
"oldPrice": 1,
"imageUrl": "https://example.com/image.jpg",
"sellerReviews": 1,
"positiveFeedbackInPercentage": 1,
"salesQuantity": 1,
"bidsCount": 1,
"sponsored": false
}
],
"columns": [],
"costToken": 1
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.