Get enrolled items

Use the Get RAP post-purchase items API with itemStatus: ENROLLED as a filter to retrieve a list of items that are currently enrolled in the Reviews Accelerator Program (RAP). This API lets you find and analyze items that are currently enrolled in the RAP, helping you track their recent performance and engagement within the specified time frame.

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

How it works

• The request specifies a filter for itemStatus: ENROLLED for a specified dateRange, so only items that are actively enrolled in the program and have relevant data from the past week are returned.
• The response provides detailed information for each enrolled item, including:
  • Item ID and Name
  • Sales numbers
  • Number of current reviews
  • Impressions and page views
  • Reviews collected in the period
  • SKU and item priority
• The response also includes metadata like the total number of items, how many were fetched, the date range, and a scroll ID for pagination.

Endpoint

GET https://marketplace.walmartapis.com/v3/growth/reviews-accelerator/items

Sample request

This example shows you how to set the necessary headers and structure your API call to retrieve a list of items eligible for the RAP. It demonstrates how to include required headers such as content-type and accept, and how to format the JSON payload to specify a filter (in this case, filtering by itemStatus: ELIGIBLE). The scrollId=* parameter is used for pagination, allowing you to scroll through large sets of results. Use this sample as a starting point, then modify it with your actual data and any additional parameters as described in the API reference.

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": "ENROLLED", "dateRange": "7DAYS" }
}
'

import requests url = 'https://marketplace.walmartapis.com/v3/growth/reviews-accelerator/items?scrollId=*'
headers = { 'accept': 'application/json', 'content-type': 'application/json', # 'Authorization': 'Bearer <YOUR_ACCESS_TOKEN>' # Add your auth token here
}
payload = { "filter": { "itemStatus": "ENROLLED", "dateRange": "7DAYS" }
} response = requests.post(url, headers=headers, json=payload)
print(response.status_code)
print(response.json())

Modify your code

• Change the itemStatus value to another valid status supported by the API. For example, you can change the status fromENROLLED to ELIGIBLE or COMPLETE.
• Change the dateRange value to a different supported time frame, such as 30DAYS or CUSTOM, if you want to adjust the period for your query.

Sample response

The following is a sample successful response provided by the API.

{ "statusCode": 200, "payload": { "totalItems": 1, "fetchedItems": 1, "dateRange": "7DAYS", "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAACUyUsWamJiNUxwcDJUU0dxbHBObmJvRUF2UQ==", "items": [ { "itemId": "100015964", "itemName": "View-Master Discovery Kids 3D Marine Life Toy Viewfinder Reel", "sales": 32, "currentReviews": 5, "impressions": 214231, "currentPageViews": 2342, "reviewsCollected": 2, "sku": "NK-WHT2XL", "itemStatus": "ENROLLED", "itemPriority": 1 } ] }
}

Result

If successful, the API responds with an HTTP status: 200 OK and a JSON payload containing a list of items that match your filter criteria. In this example, the filter is set to retrieve items with an itemStatus of ENROLLED within the last 7 days.

For each item, the response includes details such as itemId, itemName, and sku, along with additional information like sales, current reviews, impressions, page views, reviews collected, item status, and item priority.

If there are more items to retrieve, the response will also include a scrollId for pagination. If any items failed to process, the response may include error details such as itemId, errorCode, errorDescription, severity, and category.

Use this information to verify which items are currently enrolled in the Reviews Accelerator Program and to handle any errors or pagination as needed.