# Build on the balance

Source: https://www.shopwaive.com/developers

Developers

# Build on *the balance.*

The Shopwaive API 2026-11 reads and changes your customers' balances and their entries, reads your loyalty program and starts your Shopify Flow workflows, with keys you create and revoke yourself.

Live

Checkout plan

Read the API docs

Create a key

Shopwaive API 2026-11

## Balances, entries *and loyalty.*

- Customer, Action, Loyalty and Flow trigger APIs Checkout plan
- All 13 requests documented, with their errors Live
- Keys start with `swak_`; revoke each on its own Live
- Safe retries with an `Idempotency-Key` Live
- Loyalty reads at 20 requests a second a key Live
- Budgets in the Customer API with `?offers=true` Live
- Test it: send a real request from the docs Live

[Create a key](https://api.shopwaive.com/quick-start)[The full reference](https://api.shopwaive.com/reference/rest-api-documentation)[Rate limits](https://api.shopwaive.com/reference/shopwaive-api-rate-limits)

Get a customer's balance

```
curl --location \
  'https://app.shopwaive.com/api/customer/customer@example.com' \
  --header 'X-Shopwaive-Access-Token: YOUR_API_KEY' \
  --header 'X-Shopwaive-Platform: shopify'
```

From the API quick start. A refused key returns HTTP 401 with the reason in the message, and every answer carries an `X-Shopwaive-Request-Id` to quote to support.

Events

## React to every change *with Shopify Flow.*

Webhooks are no longer available. The Shopwaive triggers in Shopify Flow start a workflow when a balance changes, and Flow's Send HTTP request action can pass the change to your own server. Your server can start a workflow too, with POST /api/trigger.

[Shopwaive actions and triggers in Flow](https://www.shopwaive.com/platform#flow)[Flow trigger API](https://api.shopwaive.com/reference/rest-api-documentation/flow-trigger-api)

- **Shopwaive balance changed** Starts a workflow when a customer's balance changes.
- **Shopwaive balance changed by an order** Starts a workflow when an order changes a balance.
- **HTTP POST** Starts a workflow when your own system posts to Shopwaive.

Native loyalty

## Native loyalty, built for *your developers.*

5 Shopify Flow triggers.

### Shopify Flow triggers Live

- **Loyalty member enrolled** Starts a workflow when a customer is first counted as a member.
- **Loyalty balance pending** Starts a workflow when an order is recorded as waiting to earn.
- **Loyalty balance added** Starts a workflow when an order's points reach the balance.
- **Loyalty balance taken back** Starts a workflow when points are removed after a refund, a cancellation or an edit.
- **Loyalty reward earned** Starts a workflow when a reward is paid.

For AI assistants

## Docs your assistant *can read.*

Both doc sites publish an llms.txt file and an MCP endpoint (MCP over HTTP POST, not web pages). This site publishes its own llms.txt and a Markdown copy of every page.

- **[Help Center llms.txt](https://docs.shopwaive.com/llms.txt)** The whole Help Center as a list for assistants.
- **[API docs llms.txt](https://api.shopwaive.com/llms.txt)** The API reference as a list for assistants.
- **Help Center MCP endpoint** `https://docs.shopwaive.com/~gitbook/mcp`
- **API docs MCP endpoint** `https://api.shopwaive.com/~gitbook/mcp`
- **[This site's llms.txt](https://www.shopwaive.com/llms.txt)** Every page of shopwaive.com, with a Markdown copy of each.

Questions

## For *developers.*

**How do I get an API key?**

In your Shopify admin, open the Shopwaive app, click Settings, then the Develop tab. Type a label, click Create key and copy it; the full key is shown only once. You can create several keys and revoke each one on its own.

**What are the rate limits?**

Balance requests take 2 a second, and an enterprise key raises them to 20. The Loyalty API takes 20 requests a second for each key, with short bursts up to 40. Over the limit, the API answers 429 with the seconds to wait.

**Can I retry a request safely?**

Yes. Send an Idempotency-Key header with POST or PUT /api/customer or POST /api/trigger, and a retry with the same key changes nothing twice.

**Does Shopwaive send webhooks?**

No. Webhooks are no longer available. To react when a customer's balance changes, use the Shopwaive balance changed or Shopwaive balance changed by an order trigger in Shopify Flow, and add Flow's Send HTTP request action to reach your own server.

**Can an AI assistant read your docs?**

Yes. The Help Center and the API docs each publish an llms.txt file and an MCP endpoint that AI assistants can connect to.

## Start building on *the balance.*

Install Shopwaive from the Shopify App Store and start a 7-day free trial, or book a demo and we will map your loyalty, Budgets and B2B needs to one wallet.

Install on Shopify

Book a demo
