Manage enrollment in Reduced Referral Fee incentives
Call this endpoint to enroll any eligible item to a Reduced Referral Fee Incentive. You can also use this endpoint to unenroll any items from active Reduced referral Fee Incentives.
Note: This page describes an example using only the required parameters and inputs to modify the enrollment status of items in Reduced Referral Fee incentives. For a full list of customization options and additional capabilities, refer to the Marketplace Pricing API Reference.
Endpoint
POST https://marketplace.walmartapis.com/v3/feeds?feedType=INCENTIVE_ENROLLMENT
Sample request
This sample request enrolls an item in the Reduced Referral Fee incentive program. The request includes headers for correlation ID, access token, service name, and content type, as well as a JSON payload with details about the incentive enrollment. The request includes a feedType of INCENTIVE_ENROLLMENT
and provides item details—such as the SKU and the selected incentive (Reduced Referral Fee). The processMode: REPLACE
indicates that any existing enrollment for this item will be replaced with the new data.
curl --request POST \ --url 'https://marketplace.walmartapis.com/v3/feeds?feedType=INCENTIVE_ENROLLMENT' \ --header 'WM_QOS.CORRELATION_ID: <b3261d2d-028a-4ef7-8602-633c23200af6>' \ --header 'WM_SEC.ACCESS_TOKEN: <Basic e3tjbGllbnRfaWR9fTp7e2XR9fQ>' \ --header 'WM_SVC.NAME: Walmart Marketplace' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "ProgramActionFeedHeader": { "requestId": "0a90b332-1f92-40f4-afb1-92301f5d828e", "requestBatchId": "0a90b332-1f92-40f4-afb1-92301f5d828e", "processMode": "REPLACE", "subset": "EXTERNAL", "sellingChannel": "online", "version": "5.0.20240805-15_25_31", "locale": "en", "feedDate": "2024-07-11T00:29:58Z", "feedType": "INCENTIVE_ENROLLMENT" }, "ProgramAction": [ { "ItemIdentifiers": { "sku": "SKU-121212121212" }, "Programs": { "IncentivesEnrollment": { "referralFeeIncentiveEnrollment": "Y", "incentiveType": "Reduced Referral Fee" } } } ]
}
'
import requests url = 'https://marketplace.walmartapis.com/v3/feeds?feedType=INCENTIVE_ENROLLMENT'
headers = { 'WM_QOS.CORRELATION_ID': '<b3261d2d-028a-4ef7-8602-633c23200af6>', 'WM_SEC.ACCESS_TOKEN': '<Basic e3tjbGllbnRfaWR9fTp7e2XR9fQ>', 'WM_SVC.NAME': 'Walmart Marketplace', 'accept': 'application/json', 'content-type': 'application/json'
}
data = { "ProgramActionFeedHeader": { "requestId": "0a90b332-1f92-40f4-afb1-92301f5d828e", "requestBatchId": "0a90b332-1f92-40f4-afb1-92301f5d828e", "processMode": "REPLACE", "subset": "EXTERNAL", "sellingChannel": "online", "version": "5.0.20240805-15_25_31", "locale": "en", "feedDate": "2024-07-11T00:29:58Z", "feedType": "INCENTIVE_ENROLLMENT" }, "ProgramAction": [ { "ItemIdentifiers": { "sku": "SKU-121212121212" }, "Programs": { "IncentivesEnrollment": { "referralFeeIncentiveEnrollment": "Y", "incentiveType": "Reduced Referral Fee" } } } ]
} response = requests.post(url, headers=headers, json=data)
print(response.status_code)
print(response.json())
Modify your code
- Use a unique WM_QOS.CORRELATION_ID for each request.
- Replace with the access token.
Sample response
The sample response shows the unique ID for the feed submission; using which you check the status of the enrollment progress.
{ "feedId": "8A4C774F167B4D1B9E2C123456789012@AQMKAdz", "feedStatus": "SUBMITTED"
}
Result
If successful, the API response returns a feedID
.
You can use this feed ID with the Feed Status API or All Feed Statuses API to monitor the progress of your submission and see the line-item status.
Updated about 6 hours ago