chatId | string | optional | Chat ID, maxLength 1000 Example: example-id |
uid | string | optional | User ID, maxLength 1000 Example: example-id |
requestId | string | optional | Push ID, maxLength 1000 Example: example-id |
teamId | string | optional | Team ID, maxLength 1000 Example: example-id |
keyword | string | optional | 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 | integer | optional | Match type: 1 = phrase match (default), 2 = fuzzy match, 3 = exact match Example: 1 |
excludeKeywords | string | optional | Exclude keywords; maxLength 10240 Example: phone case |
marketplace | string | optional | 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 | string | optional | Amazon category name; maxLength 1000 Example: {} |
nodeIdPath | string | optional | Amazon category node ID; maxLength 1000 Example: {} |
filterSubNode | boolean | optional | Whether to filter subcategory nodes; only effective when nodeLabel or nodeIdPath has a value; pass JSON boolean true / false Example: false |
dataSnapshotMonth | string | optional | 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: {} |
minPrice | number | optional | Minimum price (>= 0) Example: 1 |
maxPrice | number | optional | Maximum price (>= 0) Example: 1 |
minProfit | number | optional | Minimum gross margin, unit % (1-100) Example: 1 |
maxProfit | number | optional | Maximum gross margin, unit % (1-100) Example: 1 |
minRevenue | number | optional | Minimum monthly sales revenue (>= 0) Example: 1 |
maxRevenue | number | optional | Maximum monthly sales revenue (>= 0) Example: 1 |
minFba | number | optional | Minimum FBA shipping fee (>= 0) Example: 1 |
maxFba | number | optional | Maximum FBA shipping fee (>= 0) Example: 1 |
minUnits | integer | optional | Minimum monthly sales volume (>= 0) Example: 1 |
maxUnits | integer | optional | Maximum monthly sales volume (>= 0) Example: 1 |
minAmzUnit | integer | optional | Minimum variant last-30-day sales volume (only supported when dataSnapshotMonth is a "last 30 days" type query); minimum 0 Example: 1 |
maxAmzUnit | integer | optional | Maximum variant last-30-day sales volume (only supported for last 30 days queries); minimum 0 Example: 1 |
minUnitsGrowthRate | number | optional | Minimum monthly sales volume growth rate, unit % Example: 1 |
maxUnitsGrowthRate | number | optional | Maximum monthly sales volume growth rate, unit % Example: 1 |
minBsr | integer | optional | Lowest main category BSR rank Example: 1 |
maxBsr | integer | optional | Highest main category BSR rank Example: 1 |
minBsrGrowthRate | number | optional | Minimum BSR growth rate, unit % Example: 1 |
maxBsrGrowthRate | number | optional | Maximum BSR growth rate, unit % Example: 1 |
minBsrGrowthCount | integer | optional | Minimum BSR growth count Example: 1 |
maxBsrGrowthCount | integer | optional | Maximum main category BSR growth count Example: 1 |
minSubNodeBsrRank | integer | optional | Lowest subcategory BSR rank (requires filterSubNode = true) Example: 1 |
maxSubNodeBsrRank | integer | optional | Highest subcategory BSR rank (requires filterSubNode = true) Example: 1 |
minRating | number | optional | Minimum rating value (0-5) Example: 1 |
maxRating | number | optional | Maximum rating value (0-5), 3.8-4.3 is the product improvement opportunity range Example: 1 |
minRatings | integer | optional | Minimum review count (0-10000) Example: 1 |
maxRatings | integer | optional | Maximum review count (0-10000) Example: 1 |
minRatingsGrowthCount | integer | optional | Minimum monthly new review count (>= 0) Example: 1 |
maxRatingsGrowthCount | integer | optional | Maximum monthly new review count (>= 0) Example: 1 |
minListingQualityScore | number | optional | Minimum Listing page quality score (>= 0) Example: 1 |
maxListingQualityScore | number | optional | Maximum Listing page quality score (>= 0) Example: 1 |
minVariations | integer | optional | Minimum number of variations Example: 1 |
maxVariations | integer | optional | Maximum number of variations Example: 1 |
minWeights | number | optional | Minimum weight (>= 0) Example: 1 |
maxWeights | number | optional | Maximum weight (>= 0) Example: 1 |
weightUnit | string | optional | Weight unit: g, kg, oz, lb. This field must be specified if the parameters include weight filtering Example: {} |
dimensionType | string | optional | Package dimension type (codes vary by site, see below) Example: {} |
minSellers | integer | optional | Minimum number of sellers Example: 1 |
maxSellers | integer | optional | Maximum number of sellers Example: 1 |
badgeBestSeller | string | optional | Best Seller badge filter: Y, N, or empty (all) Example: {} |
badgeAmazonsChoice | string | optional | Amazon's Choice badge filter: Y, N, or empty (all) Example: {} |
badgeNewRelease | string | optional | New Release badge filter: Y, N, or empty (all) Example: {} |
fulfillment | string | optional | 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: {} |
showVariation | string | optional | Whether to query variants: Y or N, default N Example: {} |
hideUnlistedProduct | boolean | optional | Whether to hide delisted products, default true Example: false |
listedWithinLastMonths | integer | optional | Time since listing (months), only allowed: 1, 3, 6, 12, 24 (must match these enum values; do not pass other integers) Example: 1 |
sellerNation | string | optional | Seller location code (e.g. US, CN, HK), multiple conditions comma-separated, default no limit Example: {} |
includeSellers | string | optional | Include sellers; maxLength 10240 Example: {} |
excludeSellers | string | optional | Exclude sellers; maxLength 10240 Example: {} |
includeBrands | string | optional | Include brands; maxLength 10240 Example: {} |
excludeBrands | string | optional | Exclude brands; maxLength 10240 Example: {} |
order | object | optional | Sort configuration; if passed, it is recommended to provide both field and desc (both are required in the sub-schema) Example: {} |
order.field | string | optional | 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: {} |
order.desc | string | optional | "true" descending, "false" ascending; default "true"; maxLength 1000 Example: {} |
page | integer | optional | Page number, starting from 1, default 1 Example: 1 |
size | integer | optional | Results per page (10-100), default 20 Example: 20 |