> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkout rewards

> Let signed-in Profiles apply their Omneo reward balance as a discount at Shopify checkout, with configurable product exclusions and redemption limits.

The **Checkout rewards** extension lets a signed-in Profile apply their Omneo reward balance as a discount at Shopify checkout. The Profile sees their balance in the checkout, chooses how much to apply, and the discount is applied to eligible items in the cart before payment.

<Info>
  This extension ships with the Omneo CX Shopify app. See the [Shopify extension overview](/extensions/shopify/overview) for the full extension picture, and [Rewards](/concepts/incentives/rewards) for how rewards work in Omneo.
</Info>

## How it works

1. A Profile reaches checkout signed in to their Shopify Account.
2. The **Store Rewards** block shows the Profile's available reward balance.
3. The Profile enters the amount to apply, up to the maximum the cart allows.
4. The app-managed **CX Redemption Discount** applies the amount as a discount across the eligible items in the cart.
5. Omneo records the redemption against the Profile when the order completes.

The applied amount can never exceed the **eligible cart total**: the value of the cart after removing gift cards, free items added by benefits, and any [excluded products](#product-exclusions). When **Full price items only** is enabled on the discount, already-discounted lines are also removed from the eligible total.

## The redemption discount

Reward redemption runs through a single Shopify automatic discount, the **CX Redemption Discount**, created automatically when the app is installed.

To check its status, go to **Settings > Discounts** in the Omneo Shopify app. The **Reward redemption discount** card shows whether the discount exists and is active, and offers:

| Action              | When it appears                                     | What it does                                                              |
| ------------------- | --------------------------------------------------- | ------------------------------------------------------------------------- |
| **Edit**            | Discount exists                                     | Opens the discount editor to configure cart rules and product exclusions. |
| **Create discount** | Discount is missing                                 | Creates the redemption discount with default settings.                    |
| **Repair settings** | Discount exists but its configuration is incomplete | Fills in missing configuration defaults without changing existing values. |

The card also warns when more than one redemption discount exists (remove the duplicates in Shopify admin) and when the app deployment is misconfigured, in which case contact Omneo support.

### Cart rules

Open the discount from **Settings > Discounts** (or from the Shopify admin **Discounts** list) to configure how much can be redeemed:

| Rule                                     | What it does                                                                                                                                            |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Redemption limit: minimum cart spend** | The reward can be applied once the eligible cart total reaches the **Cart minimum**. An optional **Cart maximum** blocks redemption above a cart value. |
| **Redemption limit: percentage of cart** | Caps the redeemable amount at a percentage of the eligible cart total, for example 50%. Cart minimum and maximum are ignored in this mode.              |
| **Full price items only**                | Removes already-discounted lines from the eligible cart total.                                                                                          |
| **Product exclusions**                   | Products flagged with the exclusion metafield cannot have rewards applied against them. See below.                                                      |

## Product exclusions

You can stop rewards being applied against specific products, for example gift card products or items excluded from your incentive program terms.

<Steps>
  <Step title="Create the metafield definition">
    In Shopify admin, go to **Settings > Custom data > Products** and add a definition with namespace `omneo` and key `exclude-from-discounts`. A true/false type works well, since the extension checks for the value `true`.
  </Step>

  <Step title="Flag the products">
    On each product to exclude, set the metafield to `true`. The metafield is product level: it excludes every variant of the product.
  </Step>
</Steps>

If your catalogue already uses a different metafield to flag excluded products, point the discount at it instead: open the redemption discount editor and set **Exclusion metafield namespace** and **Exclusion metafield key** in the **Product exclusions** section. Leave both blank to use the default (`omneo` / `exclude-from-discounts`).

At checkout, excluded products behave as follows:

* Excluded lines never receive any part of the reward discount, and their value does not count toward the eligible cart total or the redeemable maximum.
* When every item in the cart is excluded, the reward field is disabled and the Profile sees a message (configurable via the **Excluded Cart Message** setting).

<Note>
  Product exclusions apply to reward redemption only. Benefit discounts do not use the exclusion metafield: see [Benefits](/extensions/shopify/benefits). Gift card products are always excluded from reward redemption, with no metafield required.
</Note>

## Enable the block in checkout

In the Shopify checkout editor, add the **Store Rewards** block to the checkout layout. Without the block, the discount exists but Profiles have no way to apply their balance.

### Block settings

| Setting                         | Default                                              | Description                                                                                                                     |
| ------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| **Rewards Section Heading**     | `Store Rewards`                                      | Heading text for the rewards section.                                                                                           |
| **Loading Text**                | `Loading your rewards`                               | Text displayed while rewards are loading.                                                                                       |
| **Balance Text**                | `Your reward balance is: `                           | Text displayed before the reward balance.                                                                                       |
| **Apply Value Text**            | `Apply reward value`                                 | Label above the reward value field.                                                                                             |
| **Apply Button Text**           | `Apply`                                              | Text for the apply button.                                                                                                      |
| **Remove Button Text**          | `Remove`                                             | Text for the remove button.                                                                                                     |
| **Hide When Empty**             | Off                                                  | Hides the block entirely when the Profile has no reward balance. When off, an empty state message is shown instead.             |
| **Empty State Title**           | `No rewards available at this time.`                 | Title shown when no reward balance is available.                                                                                |
| **Empty State Subtitle**        | `Check back later for exclusive offers and rewards.` | Subtitle shown when no reward balance is available.                                                                             |
| **Minimum Cart Value**          | `0`                                                  | Fallback minimum cart value to apply rewards, used when the discount has no cart minimum configured. Set to 0 to disable.       |
| **Minimum Cart Value Message**  | `Meet minimum of {amount} to apply`                  | Message shown when the cart is below the minimum. `{amount}` is replaced with the minimum value.                                |
| **Percentage Limit Message**    | `Redeem up to {percent}% of your cart`               | Helper text shown in percentage of cart mode. `{percent}` is replaced with the configured percentage.                           |
| **Excluded Cart Message**       | `Rewards can't be applied to the items in your cart` | Message shown when every item in the cart is excluded from reward redemption.                                                   |
| **Input Helper Text**           | (empty)                                              | Optional helper text under the reward field. Leave empty to hide.                                                               |
| **Disable Currency Conversion** | Off                                                  | When enabled, reward values apply at face value in the storefront currency instead of converting from the shop's base currency. |

## Limitations

* The Profile must be signed in to their Shopify Account for the block to appear.
* Whether the reward discount can combine with benefit discounts on the same order is controlled by the combination settings on the redemption discount.
* Exclusions are product level. Individual variants cannot be excluded separately.

See [Benefits](/extensions/shopify/benefits) for the parallel benefits flow and [Credits and gift cards](/extensions/shopify/credits-and-gift-cards) for applying Credit balances at checkout.
