Capillary provides an easy process to integrate with any retail environment based on the sequences of events designed for the POS system. However, the touchpoint for the integration depends completely on the business and operational needs.

During the integration process, Capillary provides a list of APIs which can be consumed based on the tailor-made sequences and approaches decided/agreed by the business and operation of any organization. 

The Capillary APIs are completely designed based on the sequential events of the POS system which make it easier to integrate with no or minimal time. 

Customer

This section guides you on how to integrate your customer data with Capillary using APIs.  Capillary provides various APIs around processing customer data such as search customer, enroll in the loyalty program, and update details. A developer can consume these APIs based on the events provided at the POS.

The processes for basic search and customer enrollment are provided in the following.

Customer Fetch 

This event lets you fetch details of a customer that exists in the CRM database with the relevant demographic and purchase history . 

The following is the flow chart of customer fetch.

Steps to follow

  1. Insert the primary identifier of a customer (mobile no., email ID, card number, etc. ) on the POS UI. 

  2. Consume customer/get API with provided keys.

  3. If the customer exists, display all the necessary information on the POS UI. 

  4. Else, display a message stating customer does not exist and prompt for enrollment. 


For Best results

  • It is recommended to fetch customer details using mobile number with country code

  • Display the recent interaction of the customer using this API.


Customer Add (Enroll)

This event lets you enroll a user in the CRM database with the primary identifier and other demographic information (from the POS). 

The following flow chart shows how to add a customer.


Steps to follow

  1. On the POS UI, insert the primary identifier of the customer (mobile no., email ID, card number, etc. ) along with demographic details. 

  2. Consume customer/add API with provided keys.

  3. If the customer already exists, the customer details need to be updated and display the confirmation on the POS UI. 

  4. Else, display a success message display along with the customer information. 

For Best results 

  • Enroll customers with mobile numbers along with country codes. 

  • Capture as many details supported while enrolling.

  • In case of API failure, retry for 2 more times with a sleep time of 5 seconds between each call.


Transaction

This section guides you on how to integrate transactional data with Capillary using APIs. There are various types of transactions. Hence while consuming APIs, you need to pass appropriate payloads and parameter types. 

Transaction Add

This event allows you to add a transaction submitted in the POS including details such as customer, transaction (billing), and line items. Make sure transactions of loyalty events are added with valid customer identifications, else it will be posted as “not_intrested” transaction type. 

The following is the flow chart of the transaction add.

Steps to follow

  1. Complete the transaction at the POS. 

  2. Consume transaction/add API to post the transaction with relevant parameters and payloads. 

  3. If a transaction already exists, the relevant needs to display on the POS UI. 

  4. Else, it should add the transaction in the CRM DB and display a success message on the POS UI.


Points

This section guides you on how how to consume loyalty points at the POS and apply it on a transaction before the check out process. It is a two-step process - first, you need to validate the authenticity and eligibility of redemption; second, you need to process points redemption. Mentioned would be the flow for Points to be redeemed.

The following is the flow chart of points redemption.



Steps to follow

  1. Enter the points to be redeemed by a customer.

  2. Consume points/Isredeemable API to validate if the specified points can be redeemed. 

  3. If not validated, display the relevant error message on the POS UI, ignore the redemption process, and commit the transaction into the POS. 

  4. Else, apply the redeeming value on the transaction and commit the transaction into the POS. 

  5. Consume transaction/add API and on success consume point/redeem API.


Coupons

This section guides you on how to consume a loyalty coupon at the POS and apply it on a transaction before check out. It is a two-step process - first, you need to validate the authenticity and eligibility of the redemption; second, you need to redeem the coupon. 

The following is the flow chart of coupon redemption.


Steps to follow

  1. Enter the coupon code that needs to redeem.

  2. Consume coupon/Isredeemable API to validate if the coupon is redeemable. 

  3. If not validated, display the relevant error message on the POS UI, ignore the redemption process and proceed with the transaction. 

  4. Else, apply the redemption value to the transaction and commit the transaction into the POS. 

  5. After committing the transaction, consume transaction/add API and on success consume coupon/redeem API.