Skip to main content

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.

The Shopify Checkout Rewards component lets customers view and apply their Omneo reward balance at Shopify checkout.

​
How it works

  1. At checkout, the component checks if the customer has an Omneo reward balance.
  2. If a balance is available, a redemption UI is shown.
  3. The customer selects how much to redeem.
  4. A placeholder product (the “Loyalty Reward” product) is added to the cart at a negative price to apply the discount.
  5. A Shopify Script distributes the reward amount proportionally across eligible line items.
  6. On order completion, the order and transaction sync records the redemption.

​
Setup

1

Add the Loyalty Reward product

Create a non-physical Shopify product with the description “Loyalty Reward” (or equivalent). Copy its Variant ID, which you will need in the component config.
2

Create the checkout snippet

Create a snippet in your Shopify theme named omneo-checkout-rewards.liquid. Configure the variables at the top:
{% assign rewardVariantId = 0 %}
{% assign omneoTenant = "your-tenant" %}
{% assign omneoToken = false %}
{% assign hideIfInactive = true %}
{% assign autoExpandSummary = true %}
{% assign title = "Loyalty rewards available:" %}
3

Include in checkout.liquid

Add the following immediately before </head> in checkout.liquid:
{% include 'omneo-checkout-rewards' %}
4

Create the Shopify Script

Install the Script Editor app and create a Line Items script. The script proportionally distributes the reward discount across eligible line items, respecting gift card exclusions.
5

Create the token page

Create a Shopify page at /pages/omneoviewtoken using the page.omneoViewToken.liquid template. This allows the component to securely retrieve the customer’s Omneo token.
6

Hide the Loyalty Reward product

Ensure the Loyalty Reward placeholder product is not visible in any collection or public product view.
Full snippet code, the Shopify Script code, and the token page template are available from your Omneo implementation team.
See Shopify Proxy for how authentication works.