Get WFS restock recommendations

Market availability: US only

Call this endpoint to return restock recommendations for your WFS items with optional demand and insight filters. You can use this API to identify SKUs that are at risk or out of stock and display suggested replenishment quantities, days of supply, sales forecasts, and opportunity estimates.

This page describes an example using only the required parameters and inputs for retrieving restock recommendations. For a full list of customization options and additional capabilities, refer to the Walmart Recommendations API Reference.

Endpoint

GET https://marketplace.walmartapis.com/v3/wfs/recommendation/restock

Retrieve restock recommendations for the first 30 SKUs

Sample request

Use this sample request to retrieve restock recommendations for the first 30 SKUs. Note that there are no insights or filters used in this request.

curl "https://marketplace.walmartapis.com/v3/wfs/recommendation/restock" \ -H "WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6" \ -H "WM_MARKET: US" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_SEC.ACCESS_TOKEN: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM....." \ -H "WM_GLOBAL_VERSION: 3.1" \ -H "Accept: application/json" 
import requests url = "https://marketplace.walmartapis.com/v3/wfs/recommendation/restock"
headers = { "WM_QOS.CORRELATION_ID": "b3261d2d-028a-4ef7-8602-633c23200af6", "WM_MARKET": "US", "WM_SVC.NAME": "Walmart Marketplace", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_GLOBAL_VERSION": "3.1", "Accept": "application/json",
} response = requests.get(url, headers=headers, timeout=30)
response.raise_for_status()
print(response.json())

Sample response

{ "status": "SUCCESS", "payload": { "eventTime": "2025-03-15T12:04:05Z", "recommendedItems": [ { "itemId": "10000001", "gtin": "00011111111111", "vendorSku": "SKU-ALPHA", "brand": "Acme", "productName": "Acme Widget 16oz", "dailyAvgGMV": 132.4, "skuStatus": "At Risk", "daysOfSupply": 5, "recommendedReplenishmentQty": 80, "salesForecastWeek1to4": 1400, "salesForecastWeek5to8": 1600, "salesOpportunity": 2100.5, "salesForecast": 6200.0, "isInDemand": false } ], "totalRecords": 142 }
}

Retrieve recommendations using insights

Sample request

Use this sample request to retrieve restock recommendations for at risk Gross Merchandise Value (GMV) and lost sales.

curl "https://marketplace.walmartapis.com/v3/wfs/recommendation/restock?showInsights=true" \ -H "WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6" \ -H "WM_MARKET: US" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_SEC.ACCESS_TOKEN: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM....." \ -H "WM_GLOBAL_VERSION: 3.1" \ -H "Accept: application/json" 
import requests url = "https://marketplace.walmartapis.com/v3/wfs/recommendation/restock"
params = {"showInsights": "true"}
headers = { "WM_QOS.CORRELATION_ID": "b3261d2d-028a-4ef7-8602-633c23200af6", "WM_MARKET": "US", "WM_SVC.NAME": "Walmart Marketplace", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_GLOBAL_VERSION": "3.1", "Accept": "application/json",
} response = requests.get(url, headers=headers, params=params, timeout=30)
response.raise_for_status()
print(response.json())

Sample response

{ "status": "SUCCESS", "payload": { "eventTime": "2025-03-15T12:04:05Z", "recommendedItems": [ { "itemId": "10000002", "gtin": "00022222222222", "vendorSku": "SKU-BETA", "brand": "Contoso", "productName": "Contoso Bottle 1L", "dailyAvgGMV": 98.2, "skuStatus": "Out of stock", "daysOfSupply": 0, "recommendedReplenishmentQty": 300, "salesForecastWeek1to4": 2200, "salesForecastWeek5to8": 2400, "salesOpportunity": 4100.0, "salesForecast": 8600.0, "isInDemand": true } ], "insights": { "outOfStockLostSales": 8200.25, "atRiskGMV": 4100.13, "totalSalesOpportunityAmount": 12300.38 }, "totalRecords": 142, "totalHiddenRecords": 7, "totalAtRiskItems": 64, "totalOutOfStockItems": 18 }
}

Retrieve customer favorites only

Sample request

curl "https://marketplace.walmartapis.com/v3/wfs/recommendation/restock?isInDemand=true" \ -H "WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6" \ -H "WM_MARKET: US" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_SEC.ACCESS_TOKEN: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM....." \ -H "WM_GLOBAL_VERSION: 3.1" \ -H "Accept: application/json" 
import requests url = "https://marketplace.walmartapis.com/v3/wfs/recommendation/restock"
params = {"isInDemand": "true"}
headers = { "Accept": "application/json", "Content-Type": "application/json", "WM_MARKET": "US", "WM_GLOBAL_VERSION": "3.1", "wm_audit.origin_source": "SELLER_API",
} response = requests.get(url, headers=headers, params=params, timeout=30)
response.raise_for_status()
print(response.json())

Sample response

{ "status": "SUCCESS", "payload": { "eventTime": "2025-03-15T12:04:05Z", "recommendedItems": [ { "itemId": "10000003", "gtin": "00033333333333", "vendorSku": "SKU-GAMMA", "brand": "Northwind", "productName": "Northwind Snack Pack", "dailyAvgGMV": 155.0, "skuStatus": "At Risk", "daysOfSupply": 3, "recommendedReplenishmentQty": 150, "salesForecastWeek1to4": 2600, "salesForecastWeek5to8": 2800, "salesOpportunity": 3300.0, "salesForecast": 9700.0, "isInDemand": true } ], "totalRecords": 52 }
}

Modify your code

Replace all placeholder values with your actual shipment data before making the API request.

  • WM_QOS.CORRELATION_ID - Use a unique correlation UUID to track the request.
  • WM_SEC.ACCESS_TOKEN - Replace with your valid access token obtained through authentication.

Result

If successful, the API returns 200 OK with a JSON body containing status and payload. The payload includes a list of recommended replenishments with fields such as itemId, gtin, vendorSku, and recommendedReplenishmentQty.

When showInsights=true, the response also includes aggregate metrics under payload.insights, including outOfStockLostSales, atRiskGMV, and totalSalesOpportunityAmount.

If the API returns 400 Bad Request, one or more inputs are invalid. For example, non-boolean values are present for isInDemand or the limit is out of range.


Did this page help you?