Overview

Below is a high level view of the system functionality:

• Discounts - Amount Off, Percentage Off and Fixed Price discounts against line items, baskets or costs
• Expressions - allow building complex rules that can be used as conditions on discounts
• Coupon Codes - generation and evaluation
• Loyalty Schemes
• Publishing model - for testing changes before making them available to customers

The system comprises the following components:

• Portal
• Management Tooling
• Builder APIs
• Processor APIs

Portal

This is where you manage projects and their associated subscriptions, API keys and users.

See Account Setup for more details.

Management Tooling

The Management Tooling provides an interface to manage the data in the system. This is probably the easiest way to learn the system.

This uses the Builder APIs and, as such, everything you can do in the tooling can be done using the Builder APIs.

See Management Tooling for more details.

Builder APIs

The Builder APIs provide APIs to manage the data in the system.

See Builder API Guides and Builder API Definitions for more details.

Processor APIs

Evaluation is usually done at runtime by passing the relevant data to calculate discounted prices, update loyalty points, get banner content etc. This is done using the /evaluate endpoint of the Processor API.

The properties setup in the system define the properties that are allowed to be passed to the /evaluate endpoint. See the Evaluation Request guide for more details.

The Processor APIs also provide endpoints for loyalty schemes and for rollback of actions.

See Processor API Guides and Processor API Definitions for more details.