> For the complete documentation index, see [llms.txt](https://api.shopwaive.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.shopwaive.com/shopwaive-rest-api.md).

# Shopwaive REST API

The Shopwaive API reads and changes your customers' Shopwaive balances. 2026-11 is the current release; the classic routes (no version in the path) are deprecated

The Shopwaive API gives your own systems the Shopwaive balances (wallets) of your store's customers. Read each balance and every entry behind it, and add to it or take from it. Read your loyalty program and each member's points. Start your Shopify Flow workflows from your CRM or your server.

## What these pages document

The current release is **2026-11**: the version is in the path (`/api/2026-11/...`). Every request is documented with its typed fields, enum values, answers and errors, and has a **Test it** button that sends a real request with your own key: see the [reference](https://api.shopwaive.com/api-2026-11.md). When a request fails, [Errors](https://api.shopwaive.com/reference/errors.md) says what its code means and what to do next.

{% hint style="warning" %}
**The classic routes are deprecated.** The routes with no version in the path, such as `PUT /api/customer`, keep working, and no end date is set. Their pages are under **Classic REST API**. Move each call to its 2026-11 request: [Move from the classic routes](https://api.shopwaive.com/guides/migrate-from-the-classic-routes.md) maps each one. Balance changes, the Loyalty API and Shopify Flow have no 2026-11 request: keep using their classic routes.
{% endhint %}

## Want to jump right in?

Create an API key and make your first request:

{% content-ref url="/pages/DdeOtsYAiXYscR6oKtiu" %}
[Quick Start](https://api.shopwaive.com/quick-start.md)
{% endcontent-ref %}

## Want to deep dive?

Every request of the Shopwaive API 2026-11, its typed fields, answers and errors:

{% content-ref url="/pages/wqWHmPaCDpb8llvV1e3U" %}
[Shopwaive API 2026-11](https://api.shopwaive.com/api-2026-11.md)
{% endcontent-ref %}

The tools in the Shopwaive app for your developers, from a sandbox with test keys to a live key:

{% content-ref url="/pages/MiVSLAyHrlWZ8ePPD80G" %}
[Developer tools](https://api.shopwaive.com/developer-tools.md)
{% endcontent-ref %}

The classic routes (deprecated):

{% content-ref url="/pages/hgeTn2rsRK9VnlNUyAEF" %}
[Classic REST API](https://api.shopwaive.com/reference/rest-api-documentation.md)
{% endcontent-ref %}
