POS API
The EpisXperience POS APIs are designed to provide a unified interface for integrating Point-of-Sale (POS) terminals and eCommerce platforms with the EpisXperience loyalty ecosystem. These APIs enable real-time interactions with the loyalty system, ensuring smooth processing of transactions while enhancing the customer experience.
Key Features and Benefits
Seamless Integration: Facilitates real-time communication between POS terminals/eCommerce platforms and the EpisXperience loyalty system.
Customer-Centric Approach: Enhances customer satisfaction by providing clear insights into loyalty benefits before and after purchase.
Flexibility: Supports both full transaction reversals and partial reversals for greater operational control.
API Endpoints
Calculate sale informally
This endpoint simulates a sale without actually executing it.
POS terminals or eCommerce platform can use this endpoint to evaluate potential loyalty-related effects, such as points earned, discounts applied, or other benefits available for the transaction. Moreover, itprovides insights into future options or rewards based on the simulated transaction.
Use Case: Ideal for providing customers with a preview of loyalty rewards or benefits before completing a purchase.
Complete sale
This endpoint processes the actual sale and performs all loyalty-related operations. It accepts the same parameters as calculate-sale-informally, however, it actualy finalizes the transaction, updating the loyalty account with earned points, redeemed rewards, or applied benefits.
The endpoint returns the effects of the completed sale, such as updated balances or triggered rewards.
Use Case: Used to finalize transactions and ensure loyalty benefits are applied.
Revert sale
This endpoint cancels all loyalty-related operations for a previously completed sale.
To trigger the revert of sale, POS terminals or eCommerce platform must send the transaction ID of the sale to reverse all loyalty points, benefits, or rewards applied during the sale.
Use Case: Useful for handling refunds or correcting errors in completed transactions.
Revert position
This endpoint reverses all loyalty-related operations for a single item (position) within a sale.
To trigger the revert of position, POS terminals or eCommerce platform must send the transaction ID and the position within the transaction to reverse all loyalty points, benefits, or rewards applied during the sale.
Use Case: Ideal for partial returns or correcting errors related to specific items in a completed sale.