Rewards

1 operation. Every schema and example on this page is generated from the platform contract.

GET/api/v1/rewards

The caller's spendable rewards at one store.

Always scoped to the signed-in customer, ownership is part of the query, never a filter applied after fetching. Only rewards with a real cash value are returned; a voucher the merchant hasn't priced yet is real and still works in person, it just is not in this list.

auth customer:readop listSpendableRewardsrate limited errors

Parameters

store_idstring · uuidqueryrequired

The store to list spendable rewards for.

Response, 200

rewardsarray of objectrequired

4 child fields

idstringrequired

titlestringrequired

value_penceintegerrequired

expires_atstring, nullablerequired

curl -G "https://www.membber.com/api/v1/rewards" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  --data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.GET("/api/v1/rewards", {
  params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.listSpendableRewards(
    query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json

print(response)

Response, 200

{
  "rewards": [
    {
      "id": "00000d1b-0000-4000-8000-d0c500000000",
      "title": "Morning class",
      "value_pence": 1500,
      "expires_at": "<expires_at>"
    }
  ]
}