TMF671 Promotion API User Guide v4.1.0

This document is the user guide of the REST API for Promotion. It includes the model definition as well as all available operations.

It describes a single managed resource called Promotion.

Promotions are known as additional discounts, vouchers, bonus or gifts to a party who meets the pre-defined criteria. Using promotion, the enterprise can attract customers and encourage more consumption, especially continuous purchases.

This API is about the configuration and maintenance of this business object and not its execution.

The execution of promotions is the responsibility of enterprise platform which must apply the discount (or gift, voucher, etc.) based on the information retrieved from Promotion API.

Promotion API provides the following operations:

• List of existing promotions depending on filter criteria;
• Retrieval of an existing promotion by identifier;
• Partial update of an existing promotion;
• Creation (configuration) of a new promotion;
• Deletion of an existing promotion;
• Notification of events:
  • Promotion creation;
  • Promotion delete;
  • Promotion attribute update;
  • Promotion state update.