List of Price Incentive Items

Get Incentives API endpoint gives you the list of all price incentives for items in your catalog.

The details include 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), Start date (epoch Timestamp), Expiration date (epoch Timestamp), and Incentive Id.

Target Price, Expiration date, Start date, Incentive Id, and Reduced Ref fee and Enrollment Type for WF items would not be shown (null values).

Enrollment Type and Date for Eligible Reduced Referral Fee incentives will not show up.
Market availability: US

Query Params
int32
Defaults to 25

Specify number of items to return. Max limit value is 200 and min is 1.
Market availability: US

int32
Defaults to 0

Specify the offset of item list to be returned. Min offset value is 0.
Market availability: US

string
enum
Defaults to EXPIRATION_DATE

Specify the sort criteria for items. Examples of the allowed values are ITEM_ID, PRODUCT_NAME, CURRENT_PRICE, EXPIRATION_DATE, ENROLLMENT_DATE.
Market availability: US

Allowed:
string
enum
Defaults to DESC

Specify the sort order for given sort criteria. Examples of the allowed values are ASC or DESC.
Market availability: US

Allowed:
string
enum

Specify the incentive type to filter the incentive items. Allowed values include REDUCED_REFERRAL, WALMART_FUNDED.
Market availability: US

Allowed:
string
enum
required
Defaults to ELIGIBLE

Specify the incentive status to retrieve items with ELIGIBLE or ENROLLED incentives. Allowed values include ENROLLED and ELIGIBLE.
Market availability: US

Allowed:
Headers
string
required

Access token obtained from the Token API. Required for authenticating requests to Walmart Marketplace APIs.
Market availability: Global

string

A unique ID to identify the consumer request by channel.
Market availability: Global

string
required

A unique ID which identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.
Market availability: Global

string
required

Specifies the name of the Walmart service being called.
Market availability: Global

string
enum
required

Identifies the Walmart Marketplace region for the request. If not specified, US is used by default.
Market availability: Global

Allowed:
string
enum
required

Indicates the global version of the API. The default is set to 3.1.
Market availability: Global

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json