Install App from BigCommerce App Marketplace

Shoptoken App can be installed via a link or from BigC App Marketplace. On clicking install, shoptoken app will be installed on your store. Our App will require some permissions in order to read/modify your storefront.

On installation our app will do following things automatically:

1. Injects our web sdk in your storefront using the BigC’s Scripts API. The web-sdk in non-intrusive and provides a public interface, “window.shoptoken”, to provide access to Shoptoken services. If you uninstall the app, the web-sdk will be automatically removed from your storefront.
2. Creates a new digital product in your catalog, named Shoptoken Loyalty Program. This product is used to create a billing order for the monthly/annual subscription. The price can be set dynamically through a configuration setting page.
3. Creates a webhook to listen to all purchase orders that happen on your online storefront.

Widgets

Web-sdk injected at the time of app install, injects widgets in your storefront to provide shoptoken’s features to members like otp login, redeem at checkout etc. To be able to inject these widgets in the right places, we need you to add a few divs in your storefront.

1. Top Nav Bar. Place a div near the cart checkout icon or the account icon in your header. Div id should be “shoptoken-account-icon”. This div will be replaced by loyalty rewards icon which shows dynamic account balance of the member.
2. Checkout page. Add a div with id = “shoptoken-redeem-widget” on the checkout page, ideally below the order summary section. This div will be replaced by the redeem widget which allows customers to redeem tokens for store credits.
3. Order confirmation page banner. Add div with id = “shoptoken-offer-banner”. This will be replaced by the inline offer banner.

Besides the above, there are 2 more widgets that is, sign up offer and welcome page, which are displayed as overlay modals instead of inline in the page, and therefore no configuration is required from your end.

Contact the Shoptoken team to setup the following:

Program Configuration

The following fields are required to fully configure your loyalty program.

1. loyaltyProgramName : this field is the name of your program for example ABC Rewards
2. loyaltyConversionRate : the percentage cashback you want to provide in tokens for loyalty members on subsequent purchases. Eg. 10%
3. loyaltyRewardsName : A name for your brand’s rewards eg. Perks, Z Gold etc.
4. billingFrequency : monthly/yearly
5. loyaltySubscriptionCost : The cost of each billing cycle that will be billed to the active member.
6. initialPurchaseBonusRewards : You can give additional tokens to the customers who join the loyalty program. Eg. $20 will additionally be given to the customer on top of the cashback from their previous order on which the offer was displayed.
7. emailFromSource : For email communication. Eg. no-reply@rewards.example.com. Note that to enable these values, your system administrator needs to update your domain’s DKIM records by adding a new record provided by us.
8. loginPageURL : home page URL of your storefront
9. analyticsMerchantName : a unique user friendly name of your storefront. Eg. Ocean Clothings.
10. customerServicePhoneNumber : Add a phone number that will be communicated to the members via FAQ pages etc.
11. programTermsUrl : External link to the loyalty rewards program terms and conditions. Eg. www.example.com/rewards-t-n-c

Design

1. Designs/Htmls for offer page, banner and welcome page. Offer and welcome pages are rendered in an overlay iframe, while banner will be an inline iframe.
2. Designs/Htmls for emails. A customer receives different emails during the course of their membership, eg. welcome email, billing failure email, etc.

Assets

1. Rewards icon. This icon will be displayed in the shoptoken’s widgets, emails etc.