POS Loyalty Integration
API DOCUMENT
Overview
This document will provide the API details of POS loyalty integration for member earn points.
Member Registration
Client/Partner can register from Pos terminal :
Process flow:
- All new members will visit the pos terminal either phone numbe or email should be unique for each member.
- More details available at:
https://vinloyaltyswagger.vinculumgroup.net/#/Member%20Register%20API/post_member_mgmt_register
Get User profile Information
All member details will be retrieved by providing either phone number or email Id
Process flow:
- All existing member phone or email data is needed to retrieve Member profile data
- More details available at:
https://vinloyaltyswagger.vinculumgroup.net/#/IBE%20API/post_member_mgmt_fetchIBEMemberInformation
Update user Profile
This API is used to update member information
Process flow:
- POS will have a screen to update information of member
- Once the details are filled in that screen API will be triggered to update the data
- More details available at: https://vinloyaltyswagger.vinculumgroup.net/#/IBE%20API/post_member_mgmt_updateIBEMemberInformation
Validate Member
This API is used to validate the member status for earn transaction
Process flow:
- POS will use this api to validate the status of the member for earn points.
- More details available at: https://vinloyaltyswagger.vinculumgroup.net/#/Pointsoft%20Arrture%20Integration%20API/post_common_memberservice_ValidateMember
Earn points
This API is used to Earn points to member
Process flow:
- Pos will send the receipt information to the Loyalty system.
- Based on the product details the point will be calculated and credited in the member account
- More details available at: https://vinloyaltyswagger.vinculumgroup.net/#/Arrture%20WAS%20API%20Details/post_lounge_transactionservice_earn
Voucher use
This API is used to validate and consume the voucher code
Process flow:
- Pos will send the voucher code.
- Based on the voucher code the product details sent back to POS and mark the voucher as used
- More details available at:
Validate Voucher
This API is used to validate the voucher code
Process flow:
- Pos will send the voucher code.
- Based on the voucher code the product details sent back to POS .
- More details available at: