Implement loyalty points

If your store supports a loyalty program that lets shoppers earn and spend points, use the following steps to set up a loyalty program using the Commerce Admin API:

  1. Define new custom currency specifically for the loyalty program as defined in the Create a custom currency for loyalty points section.
  2. Set loyalty program details at the site level as described in the Configure a site to use loyalty programs section. This includes setting the primary currency for the site and linking price list group to sites so that you may display a catalog.
  3. Configure a payment integration to provide a payment method shoppers can use for points-based orders at checkout. Refer to the Integrate with a Loyalty Point Payment Gateway section.
  4. If you are using Avalara AvaTax or Vertex O Series tax processors, you must configure an exchange rate between your loyalty program currency and the secondary monetary currency of your site. Exchange rates are described in the Create exchange rates section.
  5. Define how taxes are calculated and configure the tax settings at the price list group level as described in the Understand tax and shipping calculations with loyalty programs section.
  6. Determine if the loyalty program will allow a mixed currency for taxes and shipping s described in the Display tax and shipping in currency for points-based orders section.
  7. Update your widgets to use the loyalty program specific widgets to display information to your shoppers, as described in the Use loyalty-specific widgets section.
  8. Add loyalty program properties to shopper profiles that let you indicate if a shopper is enrolled in your loyalty program and specify their loyalty account ID. Refer to Redeem loyalty points for this information. See Manage Shopper Profiles for details about how to create and set custom properties for shopper profiles.
  9. Update or create email templates that contain loyalty program properties.