reportPeriod | string | はい | Required reporting period: YYYY-MM for a complete calendar month, YYYY for a complete calendar year, or last30days / last12months. Uses the marketplace time zone. Daily dates, date ranges and cycleFilter are not accepted. A calendar year always runs January 1 to December 31; the current year is not automatically truncated. |
|---|
categoryId | string | はい | Category ID confirmed by the user. |
|---|
country | string | はい | Amazon marketplace explicitly selected by the user, such as US, UK or DE. Do not assume a marketplace. |
|---|
filters | object | いいえ | Brand or relevance filters. |
|---|
filters.brands | string[] | いいえ | List of brands to query. |
|---|
orders | object[] | いいえ | Sort fields and directions. |
|---|
orders[].direction | "asc" | "desc" | はい | Ascending or descending order. |
|---|
orders[].field | "sales" | "revenue" | "price" | "ratings" | "stars" | "salesMom" | "salesYoy" | "trafficScore" | "organicTrafficScoreRatio" | "height" | "length" | "width" | "weight" | はい | Sort field. |
|---|
page | integer | いいえ | Page number; default: 1. |
|---|
pageSize | integer | いいえ | Page size; default: 20. |
|---|
query | string | いいえ | Search term for the list; omitted means no text filter. |
|---|
rangeFilters | object | いいえ | Ranges on the same field are combined with OR; different fields use AND. Each range requires at least one bound and min ≤ max. Omitted bounds are unlimited. Put both bounds of one range in the same item, for example [{"min":10,"max":20}]. Separate items form a union. See each field for boundary inclusion. Listing age uses streetDays; no legacy streetSince default filter applies. |
|---|
rangeFilters.height | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.height[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.height[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.length | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.length[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.length[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.organicTrafficScoreRatio | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.organicTrafficScoreRatio[].max | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.organicTrafficScoreRatio[].min | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.price | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.price[].max | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.price[].min | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.ratings | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.ratings[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.ratings[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.revenue | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.revenue[].max | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.revenue[].min | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.sales | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.sales[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.sales[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.salesMom | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.salesMom[].max | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.salesMom[].min | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.salesYoy | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.salesYoy[].max | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.salesYoy[].min | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.stars | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.stars[].max | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.stars[].min | string | いいえ | Finite decimal number string, such as 12.50; min or max may be supplied alone. |
|---|
rangeFilters.streetDays | object[] | いいえ | Half-open range [min,max). No default listing-age limit applies to new-release rankings. If omitted, all active candidates remain and are not necessarily new releases. Explicitly set the age range for the user's goal. |
|---|
rangeFilters.streetDays[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.streetDays[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.trafficScore | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.trafficScore[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.trafficScore[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.weight | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.weight[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.weight[].min | integer | いいえ | Lower bound. |
|---|
rangeFilters.width | object[] | いいえ | Half-open range [min,max): includes min, excludes max. |
|---|
rangeFilters.width[].max | integer | いいえ | Upper bound. |
|---|
rangeFilters.width[].min | integer | いいえ | Lower bound. |
|---|
resourceId | string | はい | Available resource ID returned by the generation tool; reuse within the same task. |
|---|