The JeriCommerce public API lets your own systems work with your loyalty program. It is available for every program: all you need is an API key.

The API covers two kinds of work:

  • Loyalty actions: give points, assign coupons, redeem rewards, send wallet notifications, and read customer data. Each action is documented in Automations, with an API tab next to the Shopify Flow and Klaviyo options, so you can compare channels and build your request.
  • Reference endpoints: the ones listed on this page, such as the rewards catalog or the balance preview.

If your own system should be the source of truth for customers and balances, and receive every customer event, set up the Custom API Integration instead. It needs to be activated in JeriCommerce and works alongside this API.

Base URL

All endpoints live under your program:

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

Replace {program_slug} with your program slug or your program ID. Both work. You can find them in JeriCommerce under Settings > Technical > Program Information.

Authentication

Send your API key in the api-key header on every request. Keys belong to one program and only work with that program. See Authentication through the API to create one.

Request conventions

  • Request and response bodies are JSON. Send Content-Type: application/json.
  • Customers are identified by their email address. Emails are not case sensitive.
  • Most write endpoints accept an array of items, so you can act on many customers in one call. The limit is 100 items per request, or 250 when you sync customers or loyalty information through the Custom API Integration.

Queued endpoints

Increase balance, Decrease balance, Redeem a reward, Assign a coupon, and Send a push notification put each item in a queue and answer 201 straight away. A 201 means the request was valid, not that every item succeeded. If an item fails later (for example, the customer does not exist or does not have enough points), the API does not tell you. To confirm the result, listen to the events webhook or read the customer with Get customer details.

The other endpoints run immediately and return the result or an error in the response.

Errors

Errors return an HTTP status code and a JSON body. The message field holds a code you can use in your integration:

{
  "statusCode": 404,
  "message": "CUSTOMER_NOT_FOUND",
  "path": "/v1/programs/your-program/customers/someone@example.com",
  "timestamp": "2026-10-11T09:00:00.000Z"
}

When the request body is invalid, the status is 400 and message is a list of the fields that failed validation.

Status Meaning
400 The request is invalid: a missing or wrong field, or too many items.
403 The API key is missing or does not belong to this program, or the API integration is not active.
404 The program or the customer does not exist.
412 The customer is missing something the action needs, such as a loyalty card.

Endpoints

Endpoint What it does
Get customer details Read a customer's profile, balance, and tier.
Increase and decrease balance Add or remove points.
Execute a custom earning flow Give points through one of your custom ways to earn.
Redeem a reward Exchange a customer's points for a reward.
Assign a coupon Give a coupon to a customer.
Send a push notification Send a wallet push notification to a customer.
Get a download link Build a loyalty card download link.
Balance preview Calculate the points an order amount would earn.
List rewards Get the program's rewards catalog.
Customer tokens Create tokens for download links and Customer App session links.

The Custom API Integration adds endpoints to sync customers and loyalty information, and the events webhook.