Shop object

All shop metafield data is stored on the following metafield

{{ shop.metafields.rivo.loy | json }}

Rivo Shop Object Attributes

This is a list of attributes included in shop.metafields.rivo.loy

      points_program: {
        enabled: boolean,
        ways_to_earn: array,
        points_rewards: array,
        points_expiry_enabled: boolean
      vip_program: {
        enabled: boolean,
        tier_type: string,
        program_period: string,
        tiers: array
      referral_program: {
        enabled: boolean,
        referral_rewards: array,
        social_settings: array,
        customer_account_required: boolean
      translations: JSON,
      frontend: {
        pages: JSON,
        forms: array,
        brand_theme_settings: JSON,
        launcher_style_settings: JSON,
        custom_icons: JSON,
        css: {
          widget: widget_css,
          custom: custom_css
        potential_points: {
          order_placed: potential_points_for_order_placed

Response Key and Description

Points Program

points_program.enabledtrue, falseIs the points program enabled?
points_program.ways_to_earnarrayDifferent ways to earn points in the points program.
points_program.points_rewardsarrayRewards that can be redeemed using points.

VIP Program

vip_program.enabledtrue, falseIs the VIP program enabled?
vip_program.tier_typestringEntry method for the VIP program.
vip_program.program_periodstringThe time limit for customers to attain a VIP tier.
vip_program.tiersarrayDifferent tiers in the VIP program.

Referral Program

referral_program.enabledtrue, falseIs the referral program enabled?
referral_program.referral_rewardsarrayRewards available in the referral program.
referral_program.social_settingsarraySocial settings available for the referral program.
referral_program.customer_account_requiredtrue, falseIs a customer account required for the referral program?


translationsJSONTranslations for different elements of the programs.


frontend.pagesJSONJSON representation of frontend loyalty page settings.
frontend.formsarrayThe different frontend prompts.
frontend.brand_theme_settingsJSONJSON representation of widget brand theme settings.
frontend.launcher_style_settingsJSONJSON representation of widget launcher style settings.
frontend.custom_iconsJSONJSON representation of custom icons used in frontend design.
frontend.css.widgetwidget_cssCSS for the widget in the frontend design.
frontend.css.customcustom_cssCustom CSS used for the page in the frontend design.
frontend.potential_points.order_placedpotential_points_for_order_placedPotential points earned for an order placement.