Get customer favorite items

Market availability: US only

Use the Get RAP post-purchase items API with the isCustomerFavorite filter to retrieve only items marked as customer favorites (or only items that are not customer favorites) for a given RAP status. This helps you quickly isolate customer favorite items while still using the same filtering, search, sort, and pagination capabilities supported by the Get RAP post-purchase items API.

Note: This page describes an example using only the required parameters and inputs to get a list of customer favorite items in the RAP. For a full list of customization options and additional capabilities, refer to the Walmart Reviews API reference guide.

How it works

• You submit a request with a required itemStatus filter (for example, ELIGIBLE) and an optional dateRange.
• Set isCustomerFavorite: true to return only customer favorite items, or isCustomerFavorite: false to return only non-customer favorite items.
• The API returns up to 200 items per call and includes a scrollId in the response to fetch the next page of results.

Endpoint

POST https://marketplace.walmartapis.com/v3/growth/reviews-accelerator/items?scrollId=*

Sample request

This example retrieves eligible items that are marked as customer favorites for the last 30 days.

curl --request POST \ --url 'https://marketplace.walmartapis.com/v3/growth/reviews-accelerator/items?scrollId=*' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "filter": { "itemStatus": "ELIGIBLE", "dateRange": "30DAYS", "isCustomerFavorite": true }
}
'

Modify your code

• Change itemStatus to another valid value supported by the API (ELIGIBLE, ENROLLED, or COMPLETE).
• Change dateRange to another supported value (7DAYS, 14DAYS, or 30DAYS).
• Set isCustomerFavorite to true or false to filter items by customer favorite status. If you omit it, the API returns all items regardless of customer favorite status.
• Use the returned scrollId to retrieve the next page of results.

Sample response

{ "statusCode": 200, "payload": { "totalItems": 1, "fetchedItems": 1, "dateRange": "30DAYS", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAACUyUsWamJiNUxwcDJUU0dxbHBObmJvRUF2UQ==", "items": [ { "itemId": "test_VR2", "itemName": "Shirt Item Good Shirt Item 4", "sales": null, "currentReviews": 0, "impressions": null, "currentPageViews": null, "reviewsCollected": 0, "sku": "FLF5LBBKT", "itemStatus": "ELIGIBLE", "itemPriority": 14, "isCustomerFavorite": true } ] }
}

Result

If successful, the API responds with an HTTP status 200 OK and a JSON payload containing items that match your filter criteria. When you include isCustomerFavorite, only items matching that value are returned, and each item includes the isCustomerFavorite field in the response.