Request an assortment recommendations report
Use the assortment recommendations report to find items with strong demand where selection is limited. This report helps you identify high potential products to expand your catalog responsibly.
Endpoint
POST https://marketplace.walmartapis.com/v3/reports/reportRequests
Sample request
POST https://marketplace.walmartapis.com/v3/reports/reportRequests
Authorization: Bearer <access_token>
WM_QOS.CORRELATION_ID: <guid>
WM_SVC.NAME: Walmart Marketplace
Content-Type: application/json { "reportType": "ASSORTMENT_RECOMMENDATIONS", "format": "CSV", "rowFilters": { "multiValueFilter": { "parameter": "BRAND", "values": ["Acme", "Contoso"] }, "enumFilter": { "parameter": "ITEM_AVAILABILITY_STATUS", "values": ["EXISTING_IN_WALMART", "NEW_TO_WALMART"] }, "rangeFilter": { "parameter": "PRICE", "floorValue": 10.0, "ceilingValue": 50.0 } }
}
Track and download
- Track status with
GET /v3/reports/reportRequests/{requestId}. Status values areRECEIVED,INPROGRESS,READY, andERROR. - When status is
READY, download the file withGET /v3/reports/downloadReport?requestId={requestId}.
Filters
Use the same filter envelope used by other on request reports. Examples below show each filter type in isolation.
Multi value filter
{ "rowFilters": { "multiValueFilter": { "parameter": "CATEGORY", "values": ["Electronics", "Home"] } }
}
Parameters commonly supported include BRAND, CATEGORY, and PRODUCT_TYPE. Provide up to seven values. Values must not be empty. The service applies OR logic across values.
Enum filter
{ "rowFilters": { "enumFilter": { "parameter": "ITEM_AVAILABILITY_STATUS", "values": ["EXISTING_IN_WALMART", "NEW_TO_WALMART"] } }
}
Other enum filter parameters may include SHOPPING_TRENDS and DEMAND_SALES_TRENDS. Confirm the exact list on the report types page.
Range filter
{ "rowFilters": { "rangeFilter": { "parameter": "PRICE", "floorValue": 10.0, "ceilingValue": 50.0 } }
}
Limits
- Rate limit is two calls per seller per hour for this report type.
Report fields
CSV header names are case sensitive. Use the Header (CSV) column when parsing.
| Header (CSV) | Description |
|---|---|
| ItemRecommendationUniqueId | Unique identifier for each recommendation. |
| ItemName | Name of the recommended item. |
| Brand | Brand of the recommended item. |
| Category | Category of the recommended item. |
| PriceCurrency | Currency used for displayed prices. |
| ItemAvailabilityStatus | Whether the item is new to Walmart or already exists on Walmart. |
| GTIN | Global Trade Item Number if available. |
| UPC | Universal Product Code if available. |
| ISBN | International Standard Book Number if available. |
| EAN | European Article Number if available. |
| WalmartItemId | Walmart item identifier for existing items. |
| WalmartUrl | Product URL on Walmart for existing items. |
| WalmartItemPrice | Current item price on Walmart. |
| WalmartShippingPrice | Shipping price on Walmart. |
| WalmartTotalPrice | Item price plus shipping price on Walmart. |
| WfsIndicator | Whether the item is eligible for WFS. |
| CompetitorItemId | Competitor marketplace item identifier. |
| CompetitorUrl | Competitor marketplace product URL. |
| CompetitorItemPrice | Current item price on the competitor. |
| CompetitorShippingPrice | Shipping price on the competitor. |
| CompetitorTotalPrice | Item price plus shipping price on the competitor. |
| PotentialSales | Estimated annual revenue band across sellers. |
| ShoppingTrends | Demand types such as Most Searched For, Best Sellers, and Deal Items. |
| ProductType | Product type useful for setup and categorization. |
| PotentialSalesRank | Rank from one to ten indicating relative potential. |
| DemandSalesTrends | Months ordered by demand such as JAN, FEB, MAR. |
| WeeklyDemandTrends | Weekly demand vector such as w1:0.16 to w52:0.21. |
| MonthlyDemandTrends | Monthly demand vector such as jan24:0.34 to dec24:0.29. |
| OffersCount | Total number of offers on Walmart. |
| SearchKeywords | Popular customer search terms related to the item. |
| WeeklyPriceTrends | Weekly price history up to fifty two weeks. |
| MonthlyPriceTrends | Monthly price history up to twelve months. |
Next steps
Updated 2 days ago
