---
title: 'Shopify App'
description: 'Full-featured Shopify app with admin dashboard, cashback reports and customer management.'
---

# Shopify App

A complete Shopify app — built on Remix and Prisma — that adds Guper cashback to your store with an embedded admin interface for ongoing operations.

## What you get

- ✅ **Configuration dashboard** — set up Guper credentials and storefront behaviour without leaving Shopify Admin
- ✅ **Cashback reports** — see cumulative reward issued and redeemed
- ✅ **Customer management** — match Shopify customers with Guper persons
- ✅ Cashback amounts driven by the same [Reward by Order](/docs/{lang}/api-reference/loyalty/checkout/reward-by-order) endpoint

## One shop, one organization

The app serves a single Shopify shop per install, and that shop is linked to one Guper organization through the credentials you paste during setup. The mapping `shop → organization` is what makes the entire integration multi-tenant.

## Setup

1. Install the app on your Shopify store from the partner listing.
2. From the embedded admin, paste your **API Key** and **API Secret** — see [Authentication](/docs/{lang}/guides/authentication) for how to obtain them.
3. Pick which storefront pages should display the cashback block (Cart, Product, Checkout).
4. Run a smoke test against the [Sandbox](/docs/{lang}/guides/sandbox) before flipping to production credentials.

## Storefront customization API

Once the app is installed, the storefront script publishes a global object with the current cart's cashback values. Any theme snippet, custom section or Liquid template can read it without parsing cart attributes or listening to events:

```js
window.guper.cashback = {
  reward: 1.99,      // cashback the shopper will earn on this cart
  redeem: 4.99,      // cashback being redeemed on this cart (0 for guests)
  anonymous: false,  // true when no customer is logged in
  currency: "MXN",   // ISO code of the shop's currency
}
```

The object updates on every cart mutation (add, change, clear) and resets to zero on an empty cart. Read it after `guper:cashback:applied` is dispatched on `document` — that event fires once the values have been recomputed for the latest cart.

Example — show a small "You'll earn X" pill in a theme snippet:

```html
<div id="my-earn-pill" style="display:none"></div>
<script>
  document.addEventListener('guper:cashback:applied', () => {
    const c = window.guper?.cashback;
    if (!c || !c.reward) return;
    const pill = document.getElementById('my-earn-pill');
    pill.textContent = `Earn ${c.currency} ${c.reward.toFixed(2)}`;
    pill.style.display = 'block';
  });
</script>
```

## Need help?

The integration team is on WhatsApp 24/7 — `+52 55 2328 5981`.
