This checklist walks you through everything you need before going live with JeriCommerce using the API integration. This path is for teams that manage customers and loyalty data on their own platform and want to sync that data into JeriCommerce to power wallet passes, push notifications, and campaigns.

1. Overview of Your Stack

Before starting, confirm the tools you'll use:

  • Your platform — the system where your customer and loyalty data lives (CRM, custom backend, ERP, etc.)
  • JeriCommerce Wallet (installed from the Shopify App Store or set up standalone)
  • A developer or technical team able to make HTTP requests to the JeriCommerce API

The API integration is designed for teams that already have a loyalty system or customer database and want to connect it with JeriCommerce's wallet and notification features.

2. Generate Your API Credentials

Create an API Key

  • In your JeriCommerce dashboard, go to Settings > Technical > API Keys.
  • Click Create API Key, give it a name, and copy the value — you can only see it once.

How API authentication works

Find Your Program Slug

  • Go to Settings > Technical > Program Information.
  • Copy your Program Slug — you'll use it in all API endpoint URLs.

All API requests go to:

https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api

3. Sync Your Customers

Push your customer data into JeriCommerce so wallet passes can be generated for each customer.

  • Use the POST endpoint with feature: "users" to create or update customers.
  • You can send up to 250 customers per request.
  • Required field: email. Optional: firstName, lastName, phone, externalCustomerId, emailVerified.

Customer API reference

If you also manage loyalty data, you can send both customer and loyalty payloads in the same request — just make sure the customer entry comes before the loyalty entry.

4. Sync Loyalty Data

If your platform tracks points, tiers, or membership status, sync that data into JeriCommerce so it appears on the wallet pass.

  • Use the POST endpoint with feature: "loyalty" to send balance, tier status, and membership date.
  • Required fields: loyaltyCustomerId, balance, memberSince.
  • Optional: tierStatus (the tier name shown on the wallet pass).

Loyalty API reference

The customer must exist in JeriCommerce before you can add loyalty data. If you're syncing both in one request, place the customer payload before the loyalty payload.

5. Set Up Webhooks (Event Subscriptions)

Subscribe to JeriCommerce events so your platform stays in sync when things happen on the wallet side.

  • Go to Settings > Integrations > API and enter your Webhook URL.
  • JeriCommerce will send HTTP POST requests to your URL for all 18 events.
  • Each request includes an HMAC-SHA256 signature in the x-jericommerce-hmac-sha256 header for verification.

Events you'll receive include: wallet pass installed/uninstalled, balance changed, tier changed, reward redeemed, customer scanned at POS, and more.

Full events reference

6. Wallet Pass Design and Setup

Customize Your Loyalty Card

  • Open the Loyalty Card Designer in the JeriCommerce admin.
  • Customize your brand colors, logos, and messaging.

Set up sections and links on the back of the wallet pass for quick access to:

  • Your website or customer portal
  • Rewards or account pages
  • Product or landing pages

Generate download links for your customers so they can install the wallet pass.

  • Use the Customer Tokens API to generate download tokens for each customer.
  • The download URL format is: https://jeri.link/{slug}/download?token={base64Token}
  • You can also generate auth tokens for direct access to the customer app (rewards, profile, etc.).

Distribution options:

  • Embed download links in your emails or SMS
  • Add them to your account or profile pages
  • Include them in post-purchase flows

8. Storefront Setup

If you use Shopify, bring the wallet experience to your online store:

9. Campaigns and Notifications

Once customers have wallet passes, you can engage them with push notifications:

Scheduled Campaigns

  • Announce sales, new arrivals, or time-limited offers.

How scheduled campaigns work

Location-Based Campaigns

  • Trigger a push notification when customers are near a store.

How location-based notifications work

10. Omnichannel — Shopify POS

If you have retail stores using Shopify POS:

You're all set up and ready to launch JeriCommerce with your API integration!