Skip to main content

POS Customer Loyalty APIs

Introduction​

In the Enactor application, various types of Web Service APIs, such as SOAP and REST, are employed to interact with and manage diverse data information for integration purposes. These APIs enable two-way communication between various components and applications via a web service. The API structure is customised to communicate with specific modules using Request and Response methods according to designated protocols.

The purpose of this guide is to provide an understanding of the services that are used with regards to Customer Loyalty functions that are carried out in the POS. This guide would cover each of the Customer Loyalty POS related APIs along with the properties and values of sample requests and responses for each API.

Following are the POS Customer Loyalty APIs covered in this document:

Overview​

This guide will cover the configuration for the following:

  • POS Customer Loyalty APIs ' Describes each API, its usage, the sample requests and responses.

POS Customer Loyalty APIs​

This section describes the details & examples of how to interact with the Enactor POS Customer Loyalty services. Each API in this section will be explained with its request, response and its respective POS function.

This service allows to get a list of customers matching the search name criteria. This request is used when the user clicks on the 'Search by Name' button in any Loyalty function screen and then enters a search text in the Customer Search screen of the POS:

Following is the POS screen that displays the response for the Customer Name Search request:

If more than x records are returned, the response is paged and can be requested by the POS page by page.

For REST API - Refer Customer Name Search for more details.

For SOAP API - Refer Customer Name Search for more details.

This service allows to get a list of customers matching the search postcode criteria. This request is used when the user clicks on the 'Search by Postcode' button in any Loyalty function screen and then enters a search text in the Customer Search screen of the POS:

Following is the POS screen that displays the response for the search request:

The response consists of a paged array list ' if more than x records are returned, the response is paged and can be requested by the POS page by page.

The POS will then carry out a loyalty account search with the customer number as the search term.

For REST API - Refer Customer Postcode Search for more details.

For SOAP API - Refer Customer Postcode Search for more details.

This service allows to get a list of loyalty accounts matching a customer. Once the customer has been selected from the list presented by the customer name/postcode search, the POS will look up the applicable loyalty accounts for that customer ID.

Following is the POS screen that displays the response for the selected customer:

For REST API - Refer Loyalty Account Search for more details.

For SOAP API - Refer Loyalty Account Search for more details.

Account Balance Enquiry​

This service provides the requested balance of any customer loyalty account. This service will be requested in the POS when a card number has been entered/scanned at the POS or following a successful customer lookup.

Following is the POS screen that displays the response for the loyalty enquiry request:

For REST API - Refer Account Balance Enquiry for more details.

For SOAP API - Refer Account Balance Enquiry for more details.

Account Balance Update​

This service allows sending an update request for the account balance of a given account. In the POS, this request is sent at the time of completing a transaction, where the transaction has a customer captured who is linked to a customer loyalty, credit or deposit account. This service is also used when a credit note is added to the POS as a tender and an employee account is used as a tender.

Following is a POS screen where a customer loyalty account is being updated with the new loyalty points that have been earned in the transaction:

For REST API - Refer Account Balance Update for more details.

For REST API - Refer Account Balance Update for more details.