All Items: Manage Walmart-funded incentives enrollment

Call this endpoint to manage the enrollment status of all items in the Walmart-funded incentives program. By default, all items are auto-enrolled in Walmart-funded incentives, meaning that eligible items are automatically included in these programs to benefit from price reductions funded by Walmart.

If you wish to permanently turn off Walmart-funded incentives for all items in your catalog, you can use this API to set the Walmart-funded incentives program status to OFF.

The default value of this variable is ON. Any changes to preferences will lock in (disable) the preference option for a period of 4 hours, as indicated by the isDisabled response field of the API.

Note: This page describes an example using only the required parameters and inputs to modify the enrollment status of all items in Walmart-funded incentives. For a full list of customization options and additional capabilities, refer to the Marketplace Pricing API Reference.

Endpoint

PUT https://marketplace.walmartapis.com/v3/price/incentives/wfpreference

Sample request

This sample request includes headers for authentication and identification, along with a details of items and their desired Walmart-funded incentives program enrollment actions. In this example, Walmart-funded incentives is enabled for all items in Walmart Marketplace.

curl --request PUT \ --url 'https://marketplace.walmartapis.com/v3/price/incentives/wfpreference?autoEnrollEnabled=true' \ --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'

import requests url = 'https://marketplace.walmartapis.com/v3/price/incentives/wfpreference?autoEnrollEnabled=true'
headers = { 'WM_QOS.CORRELATION_ID': '<b3261d2d-028a-4ef7-8602-633c23200af6>', 'WM_SEC.ACCESS_TOKEN': '<Basic e3tjbGllbnRfaWR9fTp7e2XR9fQ>', 'WM_SVC.NAME': 'Walmart Marketplace', 'accept': 'application/json'
} response = requests.put(url, headers=headers) print(response.status_code)
print(response.text)

Modify your code

• Use a unique WM_QOS.CORRELATION_ID for each request.
• Replace <Basic e3tjbGllbnRfaWR9fTp7e2XR9fQ> with the access token.

Sample response

The sample response indicates that the auto-enrollment feature for price incentives is enabled, but the price incentive preference is disabled. Despite auto-enrollment being enabled, the overall preference for this incentive is not active or is turned off.

{ "autoEnrollEnabled": true, "isDisabled": true
}

Result

If the request is successful, the response returns a 200 OK status with a confirmation that the auto-enrollment setting for Walmart-funded incentives was updated.