# Matrix Rewards API

Read your loyalty programme from your own code, a terminal or an AI assistant, and make two kinds of change: add or take away a member's points, and cancel an unused reward code. You can also have every points movement sent to a web address of your own.

Every call goes to this base address, with a key made in the app:

```text
https://app.matrixrewards.co.uk/api/2026-10
```

> Available on the Shopify App Store. [Install on Shopify](https://apps.shopify.com/matrix-rewards).

## What you can do today

- [**Account**](https://matrixrewards.co.uk/docs/api/2026-10/account.md): What this key is and what it reaches.
  - [The account this key belongs to, its stores, and the key's own scopes](https://matrixrewards.co.uk/docs/api/2026-10/account.md#getMe)
  - [The API keys on this account](https://matrixrewards.co.uk/docs/api/2026-10/account.md#listKeys)
  - [Stop the key making this request, immediately](https://matrixrewards.co.uk/docs/api/2026-10/account.md#revokeThisKey)
- [**Stores**](https://matrixrewards.co.uk/docs/api/2026-10/stores.md): The stores on the account and their programmes.
  - [Every store on this account](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#listStores)
  - [One store](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#getStore)
  - [A store's programme: what is stored, the settings in force, what shoppers are actually paid, and the expiry rule](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#getProgramme)
  - [Change the earn rate, the bonuses, what a point is worth, referrals, spending any amount, the time zone, the ways to earn, or when points expire](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#updateProgramme)
  - [The rewards a shopper can spend points on at this store](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#listRewards)
  - [Add a reward shoppers can spend points on](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#addReward)
  - [Change a reward's cost, value, minimum order or label](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#changeReward)
  - [Remove a reward](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#removeReward)
  - [A store's offers](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#listOffers)
  - [Add an offer: a campaign, a product offer or a channel offer](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#addOffer)
  - [Change an offer](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#changeOffer)
  - [Remove an offer](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#removeOffer)
  - [The earn rules in force at this store](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#listRules)
  - [A store's design: the colours, words and look of the rewards panel, the product-page line and the account page](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#getDesign)
  - [Change the design: colours, words, the panel and product-line look, the account page layout, the terms link](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#updateDesign)
  - [A store's name and branding as the Matrix Rewards website shows them, and what Shopify has](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#getStoreBranding)
  - [The pictures uploaded to a store, newest first](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#listBrandImages)
  - [Upload a picture for the store's branding (a logo, a square logo, a cover)](https://matrixrewards.co.uk/docs/api/2026-10/stores.md#uploadBrandImage)
- [**Members**](https://matrixrewards.co.uk/docs/api/2026-10/members.md): Shoppers holding points, and the codes they hold.
  - [Shoppers on this account](https://matrixrewards.co.uk/docs/api/2026-10/members.md#listMembers)
  - [One shopper's record](https://matrixrewards.co.uk/docs/api/2026-10/members.md#getMember)
  - [The reward codes this shopper holds](https://matrixrewards.co.uk/docs/api/2026-10/members.md#listMemberCodes)
  - [Add points to a member's balance, or take them away](https://matrixrewards.co.uk/docs/api/2026-10/members.md#adjustMemberPoints)
  - [Cancel a reward code and give the member back its points](https://matrixrewards.co.uk/docs/api/2026-10/members.md#cancelMemberCode)
- [**Reports**](https://matrixrewards.co.uk/docs/api/2026-10/reports.md): The ledger, liability and settlement.
  - [Every points movement on this account, newest first](https://matrixrewards.co.uk/docs/api/2026-10/reports.md#listLedger)
  - [What this account owes its shoppers](https://matrixrewards.co.uk/docs/api/2026-10/reports.md#getLiabilityReport)
  - [Points earned at one store and spent at another, inside a window](https://matrixrewards.co.uk/docs/api/2026-10/reports.md#getSettlementReport)
- [**Billing**](https://matrixrewards.co.uk/docs/api/2026-10/billing.md): Usage against the plan, and the recorded plan.
  - [Orders that earned points this billing month, against the plan's cap](https://matrixrewards.co.uk/docs/api/2026-10/billing.md#getUsage)
  - [The subscriptions recorded for this account](https://matrixrewards.co.uk/docs/api/2026-10/billing.md#getPlan)
- [**Log**](https://matrixrewards.co.uk/docs/api/2026-10/log.md): What every key did, and what it was shown.
  - [What every key changed, and what it was shown](https://matrixrewards.co.uk/docs/api/2026-10/log.md#listAuditLog)
- [**Webhooks**](https://matrixrewards.co.uk/docs/api/2026-10/webhooks.md): Where every points movement is sent, and a way to check a receiver.
  - [The webhook endpoints on this account, and why any stopped](https://matrixrewards.co.uk/docs/api/2026-10/webhooks.md#listWebhookEndpoints)
  - [Send points movements to an https endpoint](https://matrixrewards.co.uk/docs/api/2026-10/webhooks.md#createWebhookEndpoint)
  - [Stop sending to an endpoint](https://matrixrewards.co.uk/docs/api/2026-10/webhooks.md#deleteWebhookEndpoint)
  - [Send one signed test event now](https://matrixrewards.co.uk/docs/api/2026-10/webhooks.md#testWebhookEndpoint)

## Not yet

- A command-line tool you can install.
- Adding Matrix Rewards to Claude, ChatGPT and other assistants in one step. Until then, an assistant can use the API only if it can make web requests itself.

## Start here

- [Authentication](https://matrixrewards.co.uk/docs/authentication.md): making a key, choosing what it may do, and sending it.
- [Safe retries and previews](https://matrixrewards.co.uk/docs/idempotency.md): sending a change twice without making it twice, and seeing a change before it happens.
- [Errors](https://matrixrewards.co.uk/docs/errors.md): every answer that is not a success, what it means and whether to send it again.
- [The reference for version 2026-10](https://matrixrewards.co.uk/docs/api/2026-10.md): every call, field and answer.

## For AI assistants

Give your assistant this address: [matrixrewards.co.uk/docs/llms.txt](https://matrixrewards.co.uk/docs/llms.txt). It is an index of these pages, each linked as plain text. Every page here also has a plain-text twin: add `.md` to its address.

---

Page: https://matrixrewards.co.uk/docs
Contract: 2026-10 sha256:35af153960028890fea5738799f5a71e535e1eea4dd3f6b8d5f50b37f02363da
