This document describes the supported feeds for the Promotions microservice.
promocodesdownload Feed
This feed is used to:
- download the available promocodes from the Promotion Admin console to the local computer in a .csv file format
- send the promocode list with all the promocodes within it to the configured email address
For more information on downloading the promo codes in the Promotions Admin console, see Downloading Promo Codes in the Promotions Admin Guide.
The frequency to run this feed is ONDEMAND.
To view the feed in the feed history page, see:
- Viewing the Running Details of a Feed Job in the Promotions Admin Guide
- Viewing Run Details of a Feed Job in the Feeds Admin Guide
promocodesgenerate Feed
This feed is used to generate the list of promo codes based on the given pattern, such as:
- define number of promocodes
- define character length of the promocode
- add prefix and/or suffix values to the promocodes
- specify alphabet, numbers, or alphanumeric characters
The frequency to run this feed is ONDEMAND.
To run the job parameters for this feed from the Feeds Admin service, you need to set the maximum limit for the following job parameters:
- promoCodeMaxLimit
- promoCodeListMaxLimit
To view the feed in the feed history page, see:
- Viewing the Running Details of a Feed Job in the Promotions Admin Guide
- Viewing Run Details of a Feed Job in the Feeds Admin Guide
For more information on generating promocodes, see Managing Promo Code Lists in the Promotions Admin Guide.
promotionlistdownload Feed
This feed is used to:
- download the promotion’s list items in a .csv file format
- send the promotion’s list with all the items within it to the configured email address
The frequency to run this feed is ONDEMAND.
To view the feed in the feed history page, see:
- Viewing the Running Details of a Feed Job in the Promotions Admin Guide
- Viewing Run Details of a Feed Job in the Feeds Admin Guide
For more information on promotion lists, see Managing Promotion Lists in the Promotions Admin Guide.
publishpromotions Feed
This feed is used to clone the promotion related data from the stage environment (authoring DB) to the production environment (live DB) , which works on three different publish types:
- FULL: Publishes the complete data from the authoring DB to the live DB.
Note: You need to run this type of feed when you have a complete change in the data. - INCREMENTAL: Publishes the incremental data from the authoring DB to the live DB
Note: You need to run this type of feed when you have minimal updates in data. - ROLLBACK: Restore the data from the previous full version.
There is no admin UI support to trigger this feed. It is integrated only at the API level.
The frequency to run this feed is ONDEMAND.
To view the feed in the feed history page, see:
- Viewing the Running Details of a Feed Job in the Promotions Admin Guide
- Viewing Run Details of a Feed Job in the Feeds Admin Guide
promocodesupload Feed
This feed is used to upload promocodes list into the Promotion Admin console as a .csv or .txt file format. After uploading, the user gets feed status e-mail notification to the registered email address.
The frequency to run this feed is ONDEMAND.
To view the feed in the feed history page, see:
- Viewing the Running Details of a Feed Job in the Promotions Admin Guide
- Viewing Run Details of a Feed Job in the Feeds Admin Guide
For more information on uploading promocodes via a file, see Uploading Promocodes via a File in the Promotions Admin Guide.
promotionlistupload Feed
This feed is used to upload the promotion list items for a specific list type and field type in a .csv format file. The uploaded promotion list is used to configure in the promotion’s conditions. After the feed is completed:
- an email is notified to the registered email address with the feed status
- the uploaded promotion list can be viewed in the List tab in the Promotions’ left navigation panel
The frequency to run this feed is ONDEMAND.
To view the feed in the feed history page, see:
- Viewing the Running Details of a Feed Job in the Promotions Admin Guide
- Viewing Run Details of a Feed Job in the Feeds Admin Guide
For more information on Uploading Promo Codes via a File, see Managing Promotion Lists in the Promotions Admin Guide.
Note: For detailed information about Feeds microservice, see here. |
Revision History
2022-11-21 | JP – Updated feeds for 8.13.0 release
2019-06-11 | PLK – Content updated.
2019-04-23 | MA – Updated feeds for April 2019 release.
2019-01-23 | PLK – Page added and content uploaded.