Welcome to QixolPromo API
Welcome to the QixolPromo Developer Documentation.
QixolPromo is an API-first promotions engine that enables software platforms and enterprise retailers to manage and evaluate promotions across multiple sales channels.
Integrate sophisticated promotion logic into your commerce applications without having to build and maintain your own promotions engine.
What can you do with the QixolPromo API?
Evaluate baskets and validate coupon codes
Submit baskets for promotion evaluation, calculate applicable discounts and determine promotional outcomes. Validate coupon codes and incorporate promotion results into your shopping and checkout experiences.
Manage promotions
Create, retrieve, update and manage promotions through the API, supporting integration with external commerce and administration systems.
Manage products and attributes
Maintain product information and attributes used by the promotions engine to determine promotion eligibility.
Work with vouchers and coupons
Integrate coupon and voucher functionality into customer journeys and external systems.
How QixolPromo fits into your commerce application
QixolPromo is designed to work alongside your existing commerce platform.
A typical integration follows the customer's shopping journey:
- Browse products — optionally display available promotions alongside products and categories.
- Build a basket — submit the basket for evaluation as products, quantities or relevant customer details change.
- Enter coupon codes — optionally validate codes when entered and include them in subsequent basket evaluations.
- Checkout — evaluate the basket to establish applicable promotions and discounts before the order is completed.
- Confirm the order — submit the confirmed basket at the appropriate point in your order-completion workflow so that applicable promotional activity can be recorded.
The exact integration points depend on your commerce platform and business requirements.
Start building
Our developer documentation is organised into two main areas.
Guides explain integration workflows, request structures, response handling and recommended implementation practices.
API Reference provides technical specifications for individual operations, including request parameters, response structures and examples.
Basket Evaluation
Basket Evaluation is the starting point for most commerce integrations.
The two principal operations are:
| Operation | Purpose |
|---|---|
| Validate Basket (10300) | Evaluate a basket and determine applicable promotions and discounts. |
| Validate Coupon Code (10200) | Check a coupon code and obtain its validation outcome. |
Begin with the Getting Started guide to prepare your environment and make your first requests.
Building a .NET integration? See the .NET client library installation guide for the QixolPromo NuGet package.
Integration considerations
A successful integration involves more than submitting a request and displaying a discount.
Depending on the promotions configured, QixolPromo may return additional or adjusted basket lines, applied promotion information, delivery discounts, issued vouchers and other results that your application needs to interpret.
Our Integration Best Practices guide explains these behaviours and how to incorporate them into a commerce application.
Need assistance?
For integration guidance, technical questions or access to a QixolPromo environment, contact your QixolPromo representative.