Promotions API

Overview

Vynamic Engage is an enterprise-scale solution that allows retail chains to collect and manage customer data, design and launch different types of loyalty programs along with marketing and engagement campaigns. Managing a large number of promotional benefits for multiple shop items can be difficult. The Promotions API enables Retailers to calculate and handle discounts based on the data sent by the basket.

Features

Managing a large number of promotional benefits for multiple shop items can be difficult. This API provides the following features to manage promotions on the POS system efficiently:

  • Calculate Benefits for a Basket: Determines and redetermines relevant promotional benefits for a customer based on the real-time modifications to the content or status of the basket. It retrieves details such as loyalty points, coupons, stamp cards to be earned by the customers.
  • Finalize Benefits for a Basket: Finalizes the determined benefits for a customer. It includes the following transactions on the POS system:
    • Issuing, redeeming, and releasing coupons
    • Issuing, redeeming, and releasing vouchers
    • Granting discounts
    • Granting, redeeming, and releasing stamp cards.
    • Granting and redeeming loyalty points.
    • Granting promotion messages, randomized and limited offers
  • Void Benefits for a Basket: Reverts the calculated and finalized benefits for a customer. This feature allows a cashier on the POS to void a basket with earned benefits such as discounts or promotions. In the case of a refund basket scenario, the POS automatically removes the granted and redeemed coupons, loyalty points, and stamp cards.
  • Health Check: Enables the API client to check the status of the following backend services:
    • Promotion Engine
    • CCVM
    • Loyalty
    • RabbitMQ
  • Search Offers: Retrieves a list of promotions with basic details: offer's identifier, name, description, validity period, location, and priority.

Benefits

  • Allows cashiers to manage promotions on the POS system efficiently.
  • Allows cashiers to save time to retrieve relevant promotional benefits in real-time.
  • Allows cashiers to track active promotions.

Security

The Promotions API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Promotions API is HTTPS.