Raw schema
{
"type": "object",
"properties": {
"chatId": {
"type": "string",
"description": "Chat ID, maxLength 1000",
"example": "example-id"
},
"uid": {
"type": "string",
"description": "User ID, maxLength 1000",
"example": "example-id"
},
"requestId": {
"type": "string",
"description": "Push ID, maxLength 1000",
"example": "example-id"
},
"teamId": {
"type": "string",
"description": "Team ID, maxLength 1000",
"example": "example-id"
},
"keyword": {
"type": "string",
"description": "Search keyword; translate to the corresponding country's language whenever possible, e.g. use English keywords for the US, German keywords for Germany, etc.; maxLength 10240",
"example": "phone case"
},
"matchType": {
"type": "integer",
"description": "Match type: 1 = phrase match (default), 2 = fuzzy match, 3 = exact match",
"example": 1
},
"excludeKeywords": {
"type": "string",
"description": "Exclude keywords; maxLength 10240",
"example": "phone case"
},
"marketplace": {
"type": "string",
"description": "Marketplace site code, default US. Only US, UK, DE, FR, JP, CA, IT, ES, MX, IN are allowed (must match this enum; AU, TR, and other unlisted sites are not supported)",
"example": "US"
},
"nodeLabel": {
"type": "string",
"description": "Amazon category name; maxLength 1000",
"example": null
},
"nodeIdPath": {
"type": "string",
"description": "Amazon category node ID; maxLength 1000",
"example": null
},
"filterSubNode": {
"type": "boolean",
"description": "Whether to filter subcategory nodes; only effective when nodeLabel or nodeIdPath has a value; pass JSON boolean true / false",
"example": false
},
"dataSnapshotMonth": {
"type": "string",
"description": "Product data snapshot month, format yyyyMM (e.g. 202412 for December 2024 data snapshot), or nearly for last 30 days real-time data. Default: nearly. Used for historical analysis and period comparison; only supports existing historical snapshots, future dates are not supported; maxLength 1000",
"example": null
},
"minPrice": {
"type": "number",
"description": "Minimum price (>= 0)",
"example": 1
},
"maxPrice": {
"type": "number",
"description": "Maximum price (>= 0)",
"example": 1
},
"minProfit": {
"type": "number",
"description": "Minimum gross margin, unit % (1-100)",
"example": 1
},
"maxProfit": {
"type": "number",
"description": "Maximum gross margin, unit % (1-100)",
"example": 1
},
"minRevenue": {
"type": "number",
"description": "Minimum monthly sales revenue (>= 0)",
"example": 1
},
"maxRevenue": {
"type": "number",
"description": "Maximum monthly sales revenue (>= 0)",
"example": 1
},
"minFba": {
"type": "number",
"description": "Minimum FBA shipping fee (>= 0)",
"example": 1
},
"maxFba": {
"type": "number",
"description": "Maximum FBA shipping fee (>= 0)",
"example": 1
},
"minUnits": {
"type": "integer",
"description": "Minimum monthly sales volume (>= 0)",
"example": 1
},
"maxUnits": {
"type": "integer",
"description": "Maximum monthly sales volume (>= 0)",
"example": 1
},
"minAmzUnit": {
"type": "integer",
"description": "Minimum variant last-30-day sales volume (only supported when dataSnapshotMonth is a \"last 30 days\" type query); minimum 0",
"example": 1
},
"maxAmzUnit": {
"type": "integer",
"description": "Maximum variant last-30-day sales volume (only supported for last 30 days queries); minimum 0",
"example": 1
},
"minUnitsGrowthRate": {
"type": "number",
"description": "Minimum monthly sales volume growth rate, unit %",
"example": 1
},
"maxUnitsGrowthRate": {
"type": "number",
"description": "Maximum monthly sales volume growth rate, unit %",
"example": 1
},
"minBsr": {
"type": "integer",
"description": "Lowest main category BSR rank",
"example": 1
},
"maxBsr": {
"type": "integer",
"description": "Highest main category BSR rank",
"example": 1
},
"minBsrGrowthRate": {
"type": "number",
"description": "Minimum BSR growth rate, unit %",
"example": 1
},
"maxBsrGrowthRate": {
"type": "number",
"description": "Maximum BSR growth rate, unit %",
"example": 1
},
"minBsrGrowthCount": {
"type": "integer",
"description": "Minimum BSR growth count",
"example": 1
},
"maxBsrGrowthCount": {
"type": "integer",
"description": "Maximum main category BSR growth count",
"example": 1
},
"minSubNodeBsrRank": {
"type": "integer",
"description": "Lowest subcategory BSR rank (requires filterSubNode = true)",
"example": 1
},
"maxSubNodeBsrRank": {
"type": "integer",
"description": "Highest subcategory BSR rank (requires filterSubNode = true)",
"example": 1
},
"minRating": {
"type": "number",
"description": "Minimum rating value (0-5)",
"example": 1
},
"maxRating": {
"type": "number",
"description": "Maximum rating value (0-5), 3.8-4.3 is the product improvement opportunity range",
"example": 1
},
"minRatings": {
"type": "integer",
"description": "Minimum review count (0-10000)",
"example": 1
},
"maxRatings": {
"type": "integer",
"description": "Maximum review count (0-10000)",
"example": 1
},
"minRatingsGrowthCount": {
"type": "integer",
"description": "Minimum monthly new review count (>= 0)",
"example": 1
},
"maxRatingsGrowthCount": {
"type": "integer",
"description": "Maximum monthly new review count (>= 0)",
"example": 1
},
"minListingQualityScore": {
"type": "number",
"description": "Minimum Listing page quality score (>= 0)",
"example": 1
},
"maxListingQualityScore": {
"type": "number",
"description": "Maximum Listing page quality score (>= 0)",
"example": 1
},
"minVariations": {
"type": "integer",
"description": "Minimum number of variations",
"example": 1
},
"maxVariations": {
"type": "integer",
"description": "Maximum number of variations",
"example": 1
},
"minWeights": {
"type": "number",
"description": "Minimum weight (>= 0)",
"example": 1
},
"maxWeights": {
"type": "number",
"description": "Maximum weight (>= 0)",
"example": 1
},
"weightUnit": {
"type": "string",
"description": "Weight unit: g, kg, oz, lb. This field must be specified if the parameters include weight filtering",
"example": null
},
"dimensionType": {
"type": "string",
"description": "Package dimension type (codes vary by site, see below)",
"example": null
},
"minSellers": {
"type": "integer",
"description": "Minimum number of sellers",
"example": 1
},
"maxSellers": {
"type": "integer",
"description": "Maximum number of sellers",
"example": 1
},
"badgeBestSeller": {
"type": "string",
"description": "Best Seller badge filter: Y, N, or empty (all)",
"example": null
},
"badgeAmazonsChoice": {
"type": "string",
"description": "Amazon's Choice badge filter: Y, N, or empty (all)",
"example": null
},
"badgeNewRelease": {
"type": "string",
"description": "New Release badge filter: Y, N, or empty (all)",
"example": null
},
"fulfillment": {
"type": "string",
"description": "Fulfillment method: single select AMZ / FBA / FBM, or multi-select such as AMZ,FBA, FBA,FBM, AMZ,FBA,FBM, etc.; multiple conditions use comma separation; empty means no limit",
"example": null
},
"showVariation": {
"type": "string",
"description": "Whether to query variants: Y or N, default N",
"example": null
},
"hideUnlistedProduct": {
"type": "boolean",
"description": "Whether to hide delisted products, default true",
"example": false
},
"listedWithinLastMonths": {
"type": "integer",
"description": "Time since listing (months), only allowed: 1, 3, 6, 12, 24 (must match these enum values; do not pass other integers)",
"example": 1
},
"sellerNation": {
"type": "string",
"description": "Seller location code (e.g. US, CN, HK), multiple conditions comma-separated, default no limit",
"example": null
},
"includeSellers": {
"type": "string",
"description": "Include sellers; maxLength 10240",
"example": null
},
"excludeSellers": {
"type": "string",
"description": "Exclude sellers; maxLength 10240",
"example": null
},
"includeBrands": {
"type": "string",
"description": "Include brands; maxLength 10240",
"example": null
},
"excludeBrands": {
"type": "string",
"description": "Exclude brands; maxLength 10240",
"example": null
},
"order": {
"type": "object",
"description": "Sort configuration; if passed, it is recommended to provide both field and desc (both are required in the sub-schema)",
"example": {}
},
"order.field": {
"type": "string",
"description": "Sort field: total_units (monthly sales), total_amount (monthly revenue), bsr_rank, price, rating, reviews, profit, reviews_rate, available_date, questions, total_units_growth, total_amount_growth, reviews_increasement, bsr_rank_cv, bsr_rank_cr, amz_unit (variant sales). Default total_units. Pass an empty string \"\" to not sort by the above business fields (full query sort semantics are handled by the server)",
"example": null
},
"order.desc": {
"type": "string",
"description": "\"true\" descending, \"false\" ascending; default \"true\"; maxLength 1000",
"example": null
},
"page": {
"type": "integer",
"description": "Page number, starting from 1, default 1",
"example": 1
},
"size": {
"type": "integer",
"description": "Results per page (10-100), default 20",
"example": 20
}
},
"required": [],
"additionalProperties": true
}