Marketing API

Overview

The Marketing API enables the integration of an API client with the Marketing service of Vynamic Engage.

Vynamic Engage is a cloud-native, microservice-based software solution which allows retail chains to collect and manage customer data, design and launch different types of loyalty programs along with marketing and engagement campaigns. Vynamic Engage supports retailers in achieving greater levels of customer engagement and retention.

The Marketing service is a component within Vynamic Engage which enables the structuring of promotional activities taken up by retailers. Specifically, the Marketing service enables the creation and maintenance of Campaigns, Promotions and Offers.
A Campaign is the top level promotional activity a company can undertake. Campaigns define the high-level goals for the company's marketing strategy and can have any number of Promotions associated with them.
Each Promotion can in turn be linked to a specific Offer.
An Offer is the most specific promotional activity and must have a benefit associated with it.

Vynamic Engage supports the following benefit types:

  • Voucher
  • Coupon
  • Discount
  • Promotion Message
  • Loyalty Points
  • Stamps

Features

The Marketing API provides the following features:

  • Campaigns:
    • Create a new campaign (POST /campaigns)
    • Retrieve a list of campaigns based on the specified search criteria (GET /campaigns)
    • Retrieve a specific campaign based on the campaign ID (GET /campaigns/{campaignId})
    • Update a campaign based on the campaign ID (PUT /campaigns/{campaignId})
    • Activate a specific campaign based on the campaign ID (PUT /campaigns/{campaignId}/activate)
    • Deactive a specific campaign based on the campaign ID (PUT /campaigns/{campaignId}/deactivate)
  • Promotions:
    • Retrieve a list of all promotions (GET /promotions)
  • Offers:
    • Retrieve a list of all offers (GET /offers)
    • Create a new offer (POST / offers)
    • Update an existing offer based on the offer Id (PUT offers/{offerId}) or external offer Id (PUT /offers/external/{offerExternalId})
    • Activate a specific offer based on the offer Id (PUT /offers/{offerId}/activate) or external offer Id (PUT /offers/external/{offerExternalId}/activate)
    • Deactivate a specific offer based on the offer Id (PUT offers/{offerId}/deactivate) or external offer ID (PUT /offers/external/{offerExternalId}/deactivate)
    • Retrieve a specific offer details based on the internal offer Id (GET /offers/{offerId}) or external offer Id (GET /offers/external/{offerExternalId}).
  • Sales Channels:
    • Import sales channels (POST /salesChannels)
    • Search and sort lists of sales channels by properties (Id, externalId, externalName, Description) (GET /salesChannels)
    • Update a sales channel with a unique Id in Vynamic Engage (PUT /salesChannels/{salesChannelId})
    • Delete a sales channel with a unique Id from the system (DELETE/ salesChannels)
  • Attributes:
    • Retrieve a collection of types of attributes (GET /Attributes/Type)
    • Retrieve a collection of attributes (GET /Attributes)
    • Retrieve the list of attributes filtered by their ID (GET /Attributes/{id})
    • Enable the POS system to create attributes (POST /Attributes)
    • Update attributes by their ID (PUT /Attributes/{id})
    • Delete attributes by their ID (DELETE /Attributes/{id})
  • Health Check:
    • The GET /healthCheck endpoint allows the API client to check the status of the dependent backend service. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy.

Security

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