--- updatedAt: 2026-04-23T19:00:11.000Z --- # Get Recommendations You can fetch the list of recommendations that are recommended for you. Using ITEM as a recommendationType, * You can get the list of ITEM recommendations. You can apply filters to fetch selective item recommendations. [block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Assortment Recommendations Overview", "version": "1.0", "description": "Assortment recommendations help sellers understand customer demand in Walmart and the external market by providing personalized item recommendations. These insights are generated by leveraging demand signals like: \n* Internal and external search \n* Best Sellers\n* Trending items\n\n The assortment recommendations API can be used to view Customer Favorites (In-demand items), demand trends, filter, reject, and bulk download the recommendations. These recommended items can be set up using the [Item Setup API](https://developer.walmart.com/api/us/mp/items).\nSellers need to provide API access key on [developer portal](https://developer.walmart.com/account/generateKey) for ‘Analytics & Growth’ to solution providers and channel partners to be able to access Assortment Growth APIs." }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" }, { "url": "https://sandbox.walmartapis.com", "description": "Sandbox URL" } ], "paths": { "/v3/growth/assortment/recommendations": { "post": { "tags": [ "Assortment Recommendations" ], "summary": "Get Recommendations", "description": "You can fetch the list of recommendations that are recommended for you. \n \nUsing ITEM as a recommendationType,\n* You can get the list of ITEM recommendations. You can apply filters to fetch selective item recommendations. \n \n\n", "externalDocs": { "description": "View Guide", "url": "/doc/us/us-mp/us-mp-assortmentrecommendations/#12957" }, "operationId": "getAssortmentRecommendations", "parameters": [ { "in": "header", "name": "WM_SEC.ACCESS_TOKEN", "description": "The access token retrieved in the Token API call", "required": true, "schema": { "type": "string" }, "example": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM....." }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "description": "A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "WM_QOS.CORRELATION_ID", "description": "A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID", "required": true, "schema": { "type": "string" }, "example": "b3261d2d-028a-4ef7-8602-633c23200af6" }, { "in": "header", "name": "WM_SVC.NAME", "description": "Walmart Service Name", "required": true, "schema": { "type": "string" }, "example": "Walmart Service Name" }, { "in": "header", "name": "Accept", "description": "Only supported Media Type : application/json", "required": true, "schema": { "type": "string" }, "example": "application/json" } ], "requestBody": { "description": "Request payload", "content": { "application/json": { "schema": { "required": [ "recommendationType" ], "type": "object", "properties": { "recommendationType": { "type": "string", "description": "| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| ITEM | To get list of recommended items | string |", "enum": [ "ITEM" ] }, "meta": { "type": "object", "properties": { "limit": { "maximum": 200, "minimum": 1, "type": "integer", "description": "Number of records expected in the request", "format": "int32", "default": 200 }, "nextCursor": { "type": "string", "description": "Used for pagination when more than 200 records are retrieved. The nextCursor value of the response includes a marker which needs to be passed in next call which retrieves the next page of results." } }, "description": "Meta information for the request." }, "filterCriteria": { "type": "object", "properties": { "searchText": { "minLength": 3, "type": "string", "description": "To filter with a search text having a word that can be part of the recommended data. " }, "multiValueFilter": { "type": "array", "description": "Filters based on multiple values associated with a specific parameter. \nNo parameter should be repeated.", "items": { "required": [ "parameter" ], "type": "object", "properties": { "parameter": { "type": "string", "description": "| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| BRAND | To filter based on list of brands which are associated with the assortment recommendations | string |\n| CATEGORY | To filter based on list of categories which are associated with the assortment recommendations | string |\n| PRODUCT_TYPE | To filter based on list of product types which are associated with the assortment recommendations | string |", "enum": [ "BRAND", "CATEGORY", "PRODUCT_TYPE" ] }, "values": { "type": "array", "description": "A list of values corresponds to the parameter in the filter. The values in the list should not be null or blank. Maximum size of the list should be 7.", "items": { "type": "string", "description": "A list of values corresponds to the parameter in the filter. The values in the list should not be null or blank. Maximum size of the list should be 7." } } }, "description": "Filters based on multiple values associated with a specific parameter. \nNo parameter should be repeated." } }, "enumFilter": { "type": "array", "description": "Filter based on preset parameters and their associated values is possible with EnumFilter. \nNo parameter should be repeated.", "items": { "type": "object", "properties": { "parameter": { "type": "string", "description": "To apply an enum filter based on the predefined parameter. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| ITEM_AVAILABILITY_STATUS | To filter based on whether the items which are new to Walmart or existing in Walmart. | string |\n| SHOPPING_TRENDS | Indicates the demand types identified in the market for an item. An item can have more than one value for this parameter. | string |\n| DEMAND_SALES_TRENDS | Indicates the months of the year when high demand is observed for the recommended item. | string |", "enum": [ "ITEM_AVAILABILITY_STATUS", "SHOPPING_TRENDS", "DEMAND_SALES_TRENDS" ] }, "values": { "type": "array", "description": "Values correspond to the parameter for applying filter on the response. The data in values[] are predefined. OR operator is used between the values. \n\n| Attribute | Associated parameter of enumFilter | Description | Data Type |\n| --- | ----------- | ----------- | ------- |\n| EXISTING_IN_WALMART | ITEM_AVAILABILITY_STATUS | To filters based on the items which are existing in Walmart. | string |\n| NEW_TO_WALMART | ITEM_AVAILABILITY_STATUS | To filters based on the items which are new to Walmart. | string |\n| MOST_SEARCHED_FOR | SHOPPING_TRENDS | Item is most searched for in the market. | string |\n| BEST_SELLERS | SHOPPING_TRENDS | Item is best seller in the market. | string |\n| DEAL_ITEMS | SHOPPING_TRENDS | Item is in demand and is a part of deals in the other marketplaces. | string |\n| JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC | DEMAND_SALES_TRENDS | Indicates the months of the year when high demand is observed for the recommended item. | string |\n", "items": { "type": "string", "description": "Values correspond to the parameter for applying filter on the response. The data in values[] are predefined. OR operator is used between the values. \n\n| Attribute | Associated parameter of enumFilter | Description | Data Type |\n| --- | ----------- | ----------- | ------- |\n| EXISTING_IN_WALMART | ITEM_AVAILABILITY_STATUS | To filters based on the items which are existing in Walmart. | string |\n| NEW_TO_WALMART | ITEM_AVAILABILITY_STATUS | To filters based on the items which are new to Walmart. | string |\n| MOST_SEARCHED_FOR | SHOPPING_TRENDS | Item is most searched for in the market. | string |\n| BEST_SELLERS | SHOPPING_TRENDS | Item is best seller in the market. | string |\n| DEAL_ITEMS | SHOPPING_TRENDS | Item is in demand and is a part of deals in the other marketplaces. | string |\n| JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC | DEMAND_SALES_TRENDS | Indicates the months of the year when high demand is observed for the recommended item. | string |\n", "enum": [ "EXISTING_IN_WALMART", "NEW_TO_WALMART", "MOST_SEARCHED_FOR", "BEST_SELLERS", "DEAL_ITEMS", "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" ] }, "enum": [ "EXISTING_IN_WALMART", "NEW_TO_WALMART", "MOST_SEARCHED_FOR", "BEST_SELLERS", "DEAL_ITEMS", "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" ] } }, "description": "Filter based on preset parameters and their associated values is possible with EnumFilter. \nNo parameter should be repeated." } }, "rangeFilter": { "type": "array", "description": "Filter based on a range with RangeFilter. You must also pass a parameter along with any of the beginning or the ending points or both. \nNo parameter should be repeated.", "items": { "type": "object", "properties": { "parameter": { "type": "string", "description": "To apply a range filter based on the predefined parameter. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| PRICE | To filter based on the price. | string |", "enum": [ "PRICE" ] }, "from": { "type": "string", "description": "Filter range start" }, "to": { "type": "string", "description": "Filter range end" } }, "description": "Filter based on a range with RangeFilter. You must also pass a parameter along with any of the beginning or the ending points or both. \nNo parameter should be repeated." } }, "isTopGoGetItem": { "type": "boolean", "description": "Filters the Top Go-Get Items, which are high-demand, customer-favorite items that sellers should prioritize adding to their Walmart catalog. Set to `true` to return only Top Go-Get Items." }, "isNewRecommendation": { "type": "boolean", "description": "Filter for newly added recommendations. These are high-demand, customer-favorite items added to the recommendation set within the past 30 days. Set to `true` to return only these items." } }, "description": "Different type of filters can be passed in this object." } } }, "examples": { "All item recommendations": { "value": { "recommendationType": "ITEM", "meta": { "limit": 2 } } }, "Item recommendations based on filter": { "value": { "recommendationType": "ITEM", "meta": { "limit": 4, "nextCursor": "AoRYPgVANXFt6AeR8QUAAAAAAAAAADkxMDEwMDMwNTZBTkRBTkRCMDg3WVYxOU05" }, "filterCriteria": { "searchText": "and", "multiValueFilter": [ { "parameter": "BRAND", "values": [ "Disney", "NINTENDO" ] }, { "parameter": "CATEGORY", "values": [ "Toys" ] }, { "parameter": "PRODUCT_TYPE", "values": [ "Action Figure Sets", "Power Tool Batteries", "Action Figures" ] } ], "enumFilter": [ { "parameter": "ITEM_AVAILABILITY_STATUS", "values": [ "NEW_TO_WALMART", "EXISTING_IN_WALMART" ] }, { "parameter": "SHOPPING_TRENDS", "values": [ "MOST_SEARCHED_FOR", "BEST_SELLERS", "DEAL_ITEMS" ] }, { "parameter": "DEMAND_SALES_TRENDS", "values": [ "DEC", "APR", "NOV", "MAR" ] } ], "rangeFilter": [ { "parameter": "PRICE", "from": "1.0", "to": "3.5" } ], "isTopGoGetItem": true, "isNewRecommendation": true } } } } } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "required": [ "recommendationType" ], "type": "object", "properties": { "recommendationType": { "type": "string", "description": "| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| ITEM | To get list of recommended items | string |", "enum": [ "ITEM" ] }, "meta": { "type": "object", "properties": { "totalRecords": { "type": "integer", "description": "The total number of records are present for the requested categorization type along with filters.", "format": "int32" }, "recordsFetched": { "type": "integer", "description": "The number of records fetched in the response.", "format": "int32" }, "limit": { "maximum": 200, "minimum": 1, "type": "integer", "description": "Number of records expected in the request", "format": "int32", "default": 200 }, "nextCursor": { "type": "string", "description": "The string returned from the initial API call to indicate nextCursor. Specify nextCursor value to retrieve the next set of records." } }, "description": "Meta information for the response." }, "records": { "type": "array", "description": "Information related to the item recommendations.", "items": { "type": "object", "properties": { "itemRecommendationUniqueId": { "type": "string", "description": "Unique identifier for the recommended item." }, "itemDetails": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the recommended item" }, "brand": { "type": "string", "description": "Brand of the recommended item" }, "category": { "type": "string", "description": "Category of the recommended item" }, "productType": { "type": "string", "description": "Indicates the product type of an item that can be used to set up this item using Item Setup APIs or Item setup bulk upload." }, "gtin": { "type": "string", "description": "GTIN of the recommended item" }, "upc": { "type": "string", "description": "UPC of the recommended item" }, "isbn": { "type": "string", "description": "ISBN of the recommended item" }, "ean": { "type": "string", "description": "EAN of the recommended item" }, "itemAvailabilityStatus": { "type": "string", "description": "Item availability status of the recommended item. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| EXISTING_IN_WALMART | Indicates that item is existing in Walmart. | string |\n| NEW_TO_WALMART | Indicates that item is new to Walmart. | string |", "enum": [ "EXISTING_IN_WALMART", "NEW_TO_WALMART" ] }, "potentialSales": { "type": "string", "description": "Indicates the potential revenue the recommended item can bring in over a year. \nThis field does not promise the numbers indicated." }, "potentialSalesRank": { "type": "string", "description": "Rank of an item, from 1 to 10 (1 being highest), that indicates the relative potential sales of a product in a category. This is an estimate based on customer demand, historical category sales and other data points." }, "isTopGoGetItem": { "type": "boolean", "description": "Top Go‑Get Items are Customer favorite items sellers are recommended to prioritize and bring to their Walmart Catalog." }, "shoppingTrends": { "type": "array", "description": "Indicates the demand type for an item. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| MOST_SEARCHED_FOR | Item is most searched for in the market. | string |\n| BEST_SELLERS | Item is best seller in the market. | string |\n| DEAL_ITEMS | Item is in demand and is a part of deals in the other marketplaces. | string |", "items": { "type": "string", "description": "Indicates the demand type for an item. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| MOST_SEARCHED_FOR | Item is most searched for in the market. | string |\n| BEST_SELLERS | Item is best seller in the market. | string |\n| DEAL_ITEMS | Item is in demand and is a part of deals in the other marketplaces. | string |", "enum": [ "MOST_SEARCHED_FOR", "BEST_SELLERS", "DEAL_ITEMS" ] }, "enum": [ "MOST_SEARCHED_FOR", "BEST_SELLERS", "DEAL_ITEMS" ] }, "demandSalesTrends": { "type": "array", "description": "Indicates the months of the year when high demand is observed for the recommended item. The sequence of month is in the decreasing order of the high demand. The values are comma separated. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC | Months of the year. | string |", "items": { "type": "string", "description": "Indicates the months in a year when high demand is observed for the recommended item. \n\n| Attribute | Description | Data Type |\n| --- | ----------- | ------- |\n| JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC | Months of the year. | string |", "enum": [ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" ] }, "enum": [ "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC" ] }, "searchKeywords": { "type": "array", "description": "List of the most popular keywords that people have searched for, where the item shows up in the result set.", "items": { "type": "string" } }, "offerCount": { "type": "number", "description": "Total number offers for this Item on Walmart." }, "freeShipping": { "type": "string", "description": "Indicates if the shipping is free for a recommended item which is a buy box winner.", "enum": [ "YES", "NO" ] }, "rating": { "type": "number", "description": "Average rating of the recommended item.", "format": "double" }, "ratingCount": { "type": "number", "description": "Total number of ratings for the recommended item." }, "primaryVariantItemId": { "type": "string", "description": "Primary variant item ID." }, "hasVariants": { "type": "boolean", "description": "Indicates to ensure whether the item has variants or not. If it is " }, "walmart": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Walmart item id." }, "url": { "type": "string", "description": "Walmart item url." }, "wfsIndicator": { "type": "boolean", "description": "Walmart fulfilment service indicator." }, "itemPrice": { "type": "object", "properties": { "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99", "format": "double" }, "currency": { "type": "string", "description": "Currency associated with the price of the item recommendation." } }, "description": "Competitor's item shipping price details of the item recommendation." }, "shippingPrice": { "type": "object", "properties": { "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99", "format": "double" }, "currency": { "type": "string", "description": "Currency associated with the price of the item recommendation." } }, "description": "Competitor's item shipping price details of the item recommendation." } }, "description": "Walmart's item information" }, "competitors": { "type": "array", "description": "Competitor's item information", "items": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Competitor item id." }, "url": { "type": "string", "description": "Competitor item url." }, "itemPrice": { "type": "object", "properties": { "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99", "format": "double" }, "currency": { "type": "string", "description": "Currency associated with the price of the item recommendation." } }, "description": "Competitor's item shipping price details of the item recommendation." }, "shippingPrice": { "type": "object", "properties": { "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99", "format": "double" }, "currency": { "type": "string", "description": "Currency associated with the price of the item recommendation." } }, "description": "Competitor's item shipping price details of the item recommendation." } }, "description": "Competitor's item information" } } }, "description": "Details of the recommended item." } }, "description": "Information related to the item recommendations." } } }, "description": "Payload in the response having the details about the item recommendations." } } }, "examples": { "All item recommendations": { "value": { "payload": { "recommendationType": "ITEM", "meta": { "totalRecords": 7, "recordsFetched": 2, "limit": 2, "nextCursor": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFmFvVTU3ZXNnUktHbjNxeUJHVHJ6VHcAAAAAAAApuhZqRkg2QURYNFFGR29ZMndCRnp4eEl3" }, "records": [ { "itemRecommendationUniqueId": "552855525", "itemDetails": { "title": "Disney Mirrorverse 5\" Figure WV1 - Sulley", "brand": "Disney", "category": "Toys", "productType": "Action Figures", "gtin": "00787926160345", "upc": "78792616034", "ean": "0787926160345", "itemAvailabilityStatus": "EXISTING_IN_WALMART", "potentialSales": "$0-$10K", "potentialSalesRank": 9, "isTopGoGetItem": false, "shoppingTrends": [ "Most searched for" ], "demandSalesTrends": [ "DEC", "APR", "NOV", "MAR" ], "searchKeywords": [ "MINIVERSE", "MINIVERSE HOLIDAY", "MINVERSE", "SULLEY", "MIRRORVERSE" ], "offerCount": 12, "freeShipping": "YES", "rating": 4.5, "ratingCount": 67, "primaryVariantItemId": "B0CW3VWC3X", "hasVariants": true, "walmart": { "itemId": "552855525", "itemPrice": { "amount": 2.3, "currency": "USD" }, "shippingPrice": { "amount": 0, "currency": "USD" } }, "competitors": [ { "itemId": "B08X954CCW", "url": "www.amazon.com/dp/B08X954CCW" } ] } }, { "itemRecommendationUniqueId": "B016GASDD8", "itemDetails": { "title": "Animal Crossing Happy Home Designer Amiibo Card Sterling 048/100", "brand": "NINTENDO", "category": "Toys", "productType": "Action Figures", "itemAvailabilityStatus": "NEW_TO_WALMART", "potentialSales": "$0-$10K", "potentialSalesRank": 9, "isTopGoGetItem": true, "shoppingTrends": [ "Most searched for" ], "demandSalesTrends": [ "DEC", "APR", "NOV", "MAR" ], "searchKeywords": [ "raymond amiibo", "raymond amiibo card" ], "offerCount": 10, "freeShipping": "NO", "rating": 4.3, "ratingCount": 16, "hasVariants": false, "competitors": [ { "itemId": "B016GASDD8", "url": "www.amazon.com/dp/B016GASDD8", "itemPrice": { "amount": 2.95, "currency": "USD" }, "shippingPrice": { "amount": 0.5, "currency": "USD" } } ] } } ] } } }, "Item recommendations based on filter": { "value": { "payload": { "recommendationType": "ITEM", "meta": { "totalRecords": 7, "recordsFetched": 2, "limit": 2, "nextCursor": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFmFvVTU3ZXNnUktHbjNxeUJHVHJ6VHcAAAAAAAApuhZqRkg2QURYNFFGR29ZMndCRnp4eEl3" }, "records": [ { "itemRecommendationUniqueId": "552855525", "itemDetails": { "title": "Disney Mirrorverse 5\" Figure WV1 - Sulley", "brand": "Disney", "category": "Toys", "productType": "Action Figures", "gtin": "00787926160345", "upc": "78792616034", "ean": "0787926160345", "itemAvailabilityStatus": "EXISTING_IN_WALMART", "potentialSales": "$0-$10K", "potentialSalesRank": 9, "isTopGoGetItem": false, "shoppingTrends": [ "Most searched for" ], "demandSalesTrends": [ "DEC", "APR", "NOV", "MAR" ], "searchKeywords": [ "MINIVERSE", "MINIVERSE HOLIDAY", "MINVERSE", "SULLEY", "MIRRORVERSE" ], "offerCount": 10, "freeShipping": "YES", "rating": 4.7, "ratingCount": 71, "primaryVariantItemId": "B0CW3VWC3X", "hasVariants": true, "walmart": { "itemId": "552855525", "itemPrice": { "amount": 2.3, "currency": "USD" }, "shippingPrice": { "amount": 0, "currency": "USD" } }, "competitors": [ { "itemId": "B08X954CCW", "url": "www.amazon.com/dp/B08X954CCW" } ] } }, { "itemRecommendationUniqueId": "B016GASDD8", "itemDetails": { "title": "Animal Crossing Happy Home Designer Amiibo Card Sterling 048/100", "brand": "NINTENDO", "category": "Toys", "productType": "Action Figures", "itemAvailabilityStatus": "NEW_TO_WALMART", "potentialSales": "$0-$10K", "potentialSalesRank": 9, "isTopGoGetItem": false, "shoppingTrends": [ "Most searched for" ], "demandSalesTrends": [ "DEC", "APR", "NOV", "MAR" ], "searchKeywords": [ "raymond amiibo", "raymond amiibo card" ], "offerCount": 10, "freeShipping": "NO", "rating": 3.9, "ratingCount": 23, "primaryVariantItemId": "B0CW3VWC3X", "hasVariants": false, "competitors": [ { "itemId": "B016GASDD8", "url": "www.amazon.com/dp/B016GASDD8", "itemPrice": { "amount": 2.95, "currency": "USD" }, "shippingPrice": { "amount": 0.75, "currency": "USD" } } ] } } ] } } } } } } } } } } } } ```