The Promotions Report contains all active and future promotions that are set up with advance price information within a timeframe. The report provides information about Promotional prices including a start and end date for a promotional price to be active for an item, and other information.
You can use the Promotions Report API to process and download the zipped CSV file. The report contains only promotional prices with status: Activated, Deactivated, Updated or Created.
To get a Promotions report, you need to specify the
type query parameter set to
promo. For example, call
Promotions Report CSV file
Upon successful call to
getReport resource to generate a Promotions Report, the API response is streamed in a .CSV file.
The response to a successful call includes a header as an attachment called Content-Disposition.
- The Content-Disposition header contains the name of the report. As an example, attachment: filename=PromotionsReport_10000000354_2020-09-02T04_56_57.922Z.zip. The title includes your partner ID (in this case, 10000000354) and the timestamp when the file was generated.
- The attachment contains the report in a compressed zip format.
The report is regenerated periodically. We recommend that you not retrieve the report more than once a day.
What’s returned in the CSV file?
To format the CSV file, you can use Java code we provide to parse it for you. See .
See Parse the Report CSV file with Java for an example Java code snippet that you can use to format the CSV file returned in the response. The Java code demonstrates the use of the header and the body when processing the response.
|Partner ID||The Seller ID on Walmart.com||Walmart|
|SKU||Unique ID of the product||Seller|
|Item ID||Numeric identifier that uniquely identifies the item||Walmart|
|Product Name||Name of the product||Seller|
|Product Category||Category of the product||Walmart|
|Promo ID||Unique ID of the promotion||Walmart|
|Promo Effective Date||The date the promotion begins||Seller|
|Promo Expiration Date||The date the promotion ends||Seller|
|Current Price||Promotion Price of the product||Seller|
|Current Price Currency||Currency of the promotion price of the product||Seller|
|Comparison Price||Base price of the product without promotion||Seller|
|Comparison Price Currency||Currency of the base price of the product||Seller|
|Promotion Type||Possible values are: Clearance, Reduced, Base||Seller|
|Promotion Status||Status of the promotion.|
Possible values are: Created, Updated, Activated, Deactivated.