Ecommerce Integration

one of the most common integrations with aiq is for ecommerce providers or in house teams looking to build on top of dutchie+, wordpress, shopify, jane roots, or others this integration helps you stop staff or bad actors from misusing loyalty points (e g , remembering phone numbers to redeem discounts later or stealing cash without applying a discount) let staff safely redeem discounts directly in your ecommerce or pos system support native redemption for aiq powered global loyalty programs shared with your customers instantly sign up new loyalty members and show welcome gifts after pin verification send us abandoned carts so we can run revenue recovery campaigns authentication create an integrations page in your app to let customers input their aiq auth credentials pos native flow \[ecommerce providers can ignore this section, see flow below] customer starts a transaction with staff in store staff member clicks on a native button "redeem discounts for customer" you call our endpoint when the button is pressed to verify the customer is there with their phone in hand (ownership) endpoint = /verify/wallet sending the {"phone" "##########" } the customer provides the pin code sent to their phone staff puts it into a ui popup "customer pin code \<input field>" when the staff member places the pin code into the pos, you then you hit endpoint = /view/wallet sending the {"phone" "##########", "code" "1234" } aiq will then respond with a wallet object containing all available discounts for this customer as well as put url's to call these put urls should be hit when the staff member clicks a "redeem this discount" + the customer has completely finished checking out do not call the put url's until checkout has been completed please make sure to append the transaction id to the end of the put url for native pos redemptions do not send it if you are an ecommerce integration enterprise support advice many public entities rely on proper reporting of loyalty points values at the transaction level aiq clients often require that the pointsdeduction in our discount object below be reflected on the transaction within the pos eventually passing it down to transactional reports for public entity auditors ecommerce native flow aiq supports two integration redemption model options model a immediate redemption (recommended) flow integrator calls /api/v2/wallet customer selects reward integrator calls redemptionurl points are immediately deducted pros real time balance accuracy cleaner reconciliation model b informational selection (pos driven redemption) flow integrator calls /api/v2/wallet customer selects reward integrator passes selection to pos (discount id or order note) pos applies reward at transaction time pos calls aiq redemption endpoint in this model aiq wallet balance is not modified until pos completes sale if order is cancelled, no refund call is required integrator does not call redemption endpoint this model is acceptable but requires clear retailer onboarding expectations pos must complete redemption ecommerce checkout flow customer arrives at ecommerce checkout page user enters in their phone number or email or you already have it as a stored customer endpoint = /verify/wallet sending the {"phone" "##########", "email" "johndoe\@email com" } aiq responds with either success user is sent a text with a special code “your code to unlock rewards is 1234” error they aren't signed up for this loyalty program yet "no customer exists with phone number error” 🔶 note 🔶 if no customer exists or they aren’t in the loyalty program yet, we highly recommend allowing customers to signup error allow user to optionally create a loyalty account by showing the following consent text “i consent to signup for the {{brand name}} rewards program where i will receive marketing communications by doing so, i understand that i am allowing {{brand name}} and it's technology provider(s) to retain my personal contact details/ engagement history for use in personalized marketing opt out at any time by replying "stop" to messages standard message and calling rates may apply ” canada replace "rewards program" with "club program" once created, you can either decide to run them through the verification process, or you can now directly retrieve their wallet and skip 2fa since this is a new user using endpoint = /wallet sending the {"phone" "##########", "email" "johndoe\@email com" } success if customer exists after either route wait for customer to receive 4 digit verification code allow customer to resend the verification code (in which you hit the same endpoint “send wallet verification request” again to refresh their code) once code is inputted, hit "retrieve wallet with verification code" with phone and code, and a wallet will be returned request a pin code be sent to the customer's phone use this endpoint during the cart building phase to verify ownership of discounts before redeeming notes for api integrations, partners may optionally implement the pin verification flow, but it is not required for redemption or wallet access the customer facing pin setting ("enable customer redemption pin codes ") is not enforced at the api level { "headers" \[], "jsonfilelocation" "https //lab alpineiq com/api/v1/swagger?filter=/api/v2/verify/contact/wallet post" } obtain the wallet for a customer with pin code get a wallet object with all discounts for a customer so that they or the staff member can redeem/ apply to cart { "headers" \[], "jsonfilelocation" "https //lab alpineiq com/api/v1/swagger?filter=/api/v2/view/contact/wallet post" } create new loyalty customer use this when a user wishes to optin to loyalty as a new customer { "headers" \[], "jsonfilelocation" "https //lab alpineiq com/api/v1/swagger?filter=/api/v2/loyalty post" } send aiq abandoned carts one of the most popular marketing campaigns is to use abandoned cart data to recapture lost revenue as an ecommerce provider, you simply send us each abandoned cart and we take care of automating the rest aiq will space out order reminders to avoid message overload, showcase cart items across our network of pages and listings, and use email, sms, and push notifications to re engage customers there are 2 pieces to abandon cart emails the pos send us the abandon cart using this endpoint { "headers" \[], "jsonfilelocation" "https //lab alpineiq com/api/v1/swagger?filter=/api/v2/cart post" } 2\ aiq does the work to enable docid\ f8 seav0qtfu86umsodal if step 1 is complete and your customers are now asking for dynamic content, please reach out to us