Retrieve price incentives data
Call this endpoint to retrieve a comprehensive list of all price incentives available for items in your catalog.
The response includes detailed information such as Item ID, Product Name, Product URL, SKU ID, Target Price, current Price, Incentive Type, Incentive Status, Base referral fee, Reduced Referral Fee, Enrollment Type, Inventory count, Enrollment Date (epoch Timestamp), Expiration date (epoch timestamp), Start date (epoch timestamp), and Incentive ID.
For Walmart-funded items, the Target Price, Expiration Date, Reduced Referral Fee, and Enrollment Type will not be displayed (null values). Additionally, Enrollment Type and Date will not be shown for items eligible for Reduced Referral Fee incentives.
Note: This page describes an example using only the required parameters and inputs to retrieve price incentive data of items in Walmart-funded incentives. For a full list of customization options and additional capabilities, refer to the Marketplace Pricing API Reference.
Endpoint
GET https://marketplace.walmartapis.com/v3/price/incentives
Reduced Referral incentive
Sample request
This sample fetches items eligible for the Reduced Referral incentive type, sorted by expiration date in descending order, with a limit of 25 items starting from the first item.
curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/price/incentives?limit=25&offset=0&sortBy=EXPIRATION_DATE&sortOrder=DESC&incentiveType=REDUCED_REFERRAL&incentiveStatus=ELIGIBLE' \ --header 'WM_QOS.CORRELATION_ID: CORRELATION_ID' \ --header 'WM_SEC.ACCESS_TOKEN: ACCESS_TOKEN' \ --header 'WM_SVC.NAME: Walmart Service Name' \ --header 'accept: application/json'
import requests url = 'https://marketplace.walmartapis.com/v3/price/incentives'
params = { 'limit': 25, 'offset': 0, 'sortBy': 'EXPIRATION_DATE', 'sortOrder': 'DESC', 'incentiveType': 'REDUCED_REFERRAL', 'incentiveStatus': 'ELIGIBLE'
}
headers = { 'WM_QOS.CORRELATION_ID': 'CORRELATION_ID', 'WM_SEC.ACCESS_TOKEN': 'ACCESS_TOKEN', 'WM_SVC.NAME': 'Walmart Service Name', 'accept': 'application/json'
} response = requests.get(url, params=params, headers=headers) print(response.json())
Modify your code
Replace WM_SEC.ACCESS_TOKEN
and WM_QOS.CORRELATION_ID
with actual values.
Sample response
The sample response includes pagination details and a list of items eligible for the "Reduced Referral" incentive, with each item showing its ID, name, URL, image URL, SKU, current and target prices, shipping price, incentive type, referral fees, enrollment details, status, inventory count, and expiration date.
{ "pageContext": { "pageNo": 1, "currentPageCount": 1, "totalCount": 10, "totalPages": 1 }, "items": [ { "itemId": "649861121", "productName": "Fake Firearm", "productUrl": "http://localhost", "productImageUrl": "http://localhost", "skuId": "sku123", "currentPrice": 20.5, "targetPrice": 20, "shippingPrice": 2, "incentiveType": "REDUCED_REFERRAL", "baseReferralFee": 8, "reducedReferralFee": 7, "enrollmentType": "MANUAL", "enrollmentDate": "1652857199000", "incentiveStatus": "NEW", "inventoryCount": "200", "expirationDate": "1660805999000" } ]
}
Walmart-funded incentive
Sample request
This sample fetches items eligible for the Walmart-funded incentive type, sorted by expiration date in descending order, with a limit of 25 items starting from the first item.
curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/price/incentives?limit=25&offset=0&sortBy=EXPIRATION_DATE&sortOrder=DESC&incentiveType=WALMART_FUNDED&incentiveStatus=ELIGIBLE' \ --header 'WM_QOS.CORRELATION_ID: CORRELATION_ID' \ --header 'WM_SEC.ACCESS_TOKEN: ACCESS_TOKEN' \ --header 'WM_SVC.NAME: Walmart Service Name' \ --header 'accept: application/json'
import requests url = "https://marketplace.walmartapis.com/v3/price/incentives"
params = { "limit": 25, "offset": 0, "sortBy": "EXPIRATION_DATE", "sortOrder": "DESC", "incentiveType": "WALMART_FUNDED", "incentiveStatus": "ELIGIBLE"
} headers = { "WM_QOS.CORRELATION_ID": "YOUR_CORRELATION_ID", "WM_SEC.ACCESS_TOKEN": "YOUR_ACCESS_TOKEN", "WM_SVC.NAME": "Walmart Service Name", "accept": "application/json"
} response = requests.get(url, headers=headers, params=params) if response.status_code == 200: data = response.json() print("Incentives retrieved successfully:") print(data)
else: print(f"Request failed with status code: {response.status_code}") print(response.text)
Modify your code
Replace WM_SEC.ACCESS_TOKEN
and WM_QOS.CORRELATION_ID
with actual values.
Sample response
The sample response includes pagination details and a list of items eligible for the Walmart-funded incentive. Each item shows its ID, SKU, original price, incentive (discounted) price, incentive type, funding source, referral fee percentage, enrollment status, incentive start and end dates, currency, and current eligibility status.
{ "incentives": [ { "itemId": "1234567890", "sku": "WM-ITEM-001", "price": 100.00, "incentivePrice": 90.00, "incentiveType": "WALMART_FUNDED", "incentiveStartDate": "2025-05-01T00:00:00Z", "incentiveEndDate": "2025-05-31T23:59:59Z", "status": "ELIGIBLE", "fundingSource": "WALMART", "originalReferralFeePercent": 15.0, "reducedReferralFeePercent": null, "currency": "USD" }, { "itemId": "9876543210", "sku": "WM-ITEM-002", "price": 75.00, "incentivePrice": 70.00, "incentiveType": "WALMART_FUNDED", "incentiveStartDate": "2025-05-10T00:00:00Z", "incentiveEndDate": "2025-06-10T23:59:59Z", "status": "ACTIVE", "fundingSource": "WALMART", "originalReferralFeePercent": 15.0, "reducedReferralFeePercent": null, "currency": "USD" } ], "totalCount": 2, "limit": 25, "offset": 0
}
Result
If successful, the API response returns an HTTP 200 OK status with a JSON payload containing the items eligible for price incentives. The response provides pagination details and a list of items eligible for the incentive, including key product information such as:
- itemID - The unique identifier for the item.
- productName - The name of the product.
- incentiveType - The type of incentive applied to the item.
- prices - Current price, target price, and shipping price.
- inventoryCount - The number of items available in inventory.
- referral fees - Base referral fee and reduced referral fee.
- expirationDate - The date when the incentive expires.
Updated about 5 hours ago