Consumers, wallets and goals
This page covers the consumer profile, wallet (vouchers, coupons, points, referrals), goal, tier and transaction history APIs.
| Item | Value |
|---|---|
| Authentication | X-Api-Key |
| Identity key | Immutable integrationId |
| Test base URL | https://api-integration.test.kaizenloyalty.com/api/v1 |
| Scope | Profile, wallet, goals, tiers and transaction history |
See Environments for base URLs and Authentication and security for API keys. You can try every endpoint in the API reference.
The following parts of this page have not yet been verified against the live API: the tierprograms endpoint, the organization-scoped attribute upsert endpoint, and recently added fields in the voucher, coupon and transaction responses. Values in the JSON examples for these parts are representative, not taken from real responses.
Endpoint catalog
| Operation | Method | Path | Success |
|---|---|---|---|
| Upsert Consumer | POST | /consumers/upsert | 200 |
| Upsert Organization Attributes | PUT | /consumers/upsert/organization | 204 |
| Consumer Profile | GET | /consumers/{integrationId}/profile | 200 |
| Delete Consumer | DELETE | /consumers/{integrationId} | 204 |
| Vouchers | GET | /consumerwallets/vouchers | 200 |
| Coupons | GET | /consumerwallets/coupons | 200 |
| Points | GET | /consumerwallets/{integrationId}/points | 200 |
| Program Transactions | GET | /consumerwallets/programtransactions | 200 |
| Referrals | GET | /consumerwallets/referrals | 200 |
| Tier Programs | GET | /consumerwallets/{integrationId}/tierprograms | 200 |
| Active Goals | GET | /goals/active | 200 |
| Consumer Transactions | GET | /transactions/search | 200 |
| Get or Insert Consumer | GET | /consumers/getorinsert | 200 |
| Burn Coupon Code | POST | /consumercouponcodes/burn | 200 |
| Loyalty Programs | GET | /loyaltyprograms/list | 200 |
| Tier Program Definitions | GET | /tierprograms/list | 200 |
The following endpoints, and the SDK /me variants listed under SDK current-consumer (/me) endpoints below, have not yet been verified against the live API:
GET /consumers/getorinsertPOST /consumercouponcodes/burnGET /loyaltyprograms/listGET /tierprograms/list
Consumer domain model
A consumer is the KLP counterpart of a customer in your system. The consumer profile combines:
- Custom attributes sent by your application
- Session and effect metrics
- Wallet assets
- Goal and tier state
- Transaction history
The integrationId must be permanent and immutable.
Recommended identifiers:
- Your internal database UUID
- A stable customer or account ID
- An opaque identifier that contains no PII
Avoid:
- Email addresses
- Phone numbers
- Usernames that can change
- Any direct PII
Upsert consumer
Endpoint
POST /consumers/upsert
X-Api-Key: <API_KEY>
Content-Type: application/json
Request example
{
"RunRuleEngine": false,
"OverWriteConsumer": false,
"IntegrationId": "515ace2c-e89b-4307-a1a7-946f1622e416",
"Attributes": {
"BirthDate": "2024-05-20"
}
}
Send field names with the exact casing shown in the request example (for example OverWriteConsumer). Do not rely on case-insensitive JSON binding.
Fields
| Field | Type | Required | Behaviour |
|---|---|---|---|
RunRuleEngine | bool | Yes (send it explicitly) | Runs the rule engine during the upsert |
OverWriteConsumer | bool | Yes (send it explicitly) | Overwrites the existing consumer attribute set |
IntegrationId | string | Yes | Immutable consumer identity |
Attributes | Dictionary<string, object>? | No | Custom attributes |
Merge and overwrite semantics
OverWriteConsumer: false: existing attributes are merged with the new attributes.OverWriteConsumer: true: the consumer record and attribute set are overwritten.
Rule engine response
With RunRuleEngine: false:
{
"effects": []
}
With RunRuleEngine: true, the endpoint returns the standard rule engine result model (see Effects):
{
"effects": [
{
"actionType": "GiveReferralCode",
"detail": {
"effectTransactionId": "064ba906-57ed-4e60-95d0-01f3717725b5",
"referralCode": {
"poolId": "6908555e5308cd2540202ae3",
"id": "6908555e5308cd2540202ae3-690855697f49535f8e8070d0",
"code": "VLUJQ8LD",
"type": "Award"
}
}
}
],
"ruleFailureReasons": []
}
Organization-scoped attributes
This endpoint has not yet been verified against the live API. Values in the example are representative.
Attributes defined at organization level are shared by all applications in the same organization. Write them with a separate endpoint:
PUT /consumers/upsert/organization
X-Api-Key: <API_KEY>
Content-Type: application/json
{
"Overwrite": false,
"IntegrationId": "515ace2c-e89b-4307-a1a7-946f1622e416",
"Attributes": {
"MembershipLevel": "Gold"
}
}
| Field | Type | Required | Behaviour |
|---|---|---|---|
Overwrite | bool | No (default false) | false: merges with the existing organization attributes; true: replaces the organization attribute set entirely |
IntegrationId | string | Yes | Immutable consumer identity |
Attributes | Dictionary<string, object> | Yes | Organization-scoped attribute keys only |
Behaviour:
- Success:
204 No Content. The rule engine does not run and no effects are returned. - If the consumer does not exist, it is created with the organization attributes.
- Empty keys and values are ignored.
- If you send an application-scoped key, the endpoint returns
400 Bad Requestand the message lists the offending keys. Send those keys withPOST /consumers/upsertinstead.
Consumer profile
Endpoint
GET /consumers/{integrationId}/profile
Response
{
"integrationId": "515ace2c-e89b-4307-a1a7-946f1622e412",
"environmentType": "Live",
"createdDate": "2026-02-16T18:26:25.299+00:00",
"latestActivityDate": null,
"closedSessions": 0,
"discountedSessions": 0,
"totalDiscountAmount": 0,
"totalSessionAmount": 0,
"totalEffectParticipation": 0,
"attributes": {
"BirthDate": "2024-05-20"
}
}
| Field | Type | Description |
|---|---|---|
integrationId | string? | Consumer identity |
environmentType | enum | Sandbox or Live |
createdDate | DateTime | Creation timestamp |
latestActivityDate | DateTime? | Latest activity |
closedSessions | int | Closed session count |
discountedSessions | int | Discounted session count |
totalDiscountAmount | decimal | Total discount |
totalSessionAmount | decimal | Total session amount |
totalEffectParticipation | int | Effect participation count |
attributes | Dictionary<string, object>? | Consumer attributes |
attributes values are not limited to strings; they can be numbers, booleans or nested JSON. Deserialize this field as typed values and do not assume string.
If the consumer is not found:
404 Not Found
{
"Code": 2002,
"Message": "Code:2002, Message:Consumer not found!"
}
Delete consumer
Endpoint
DELETE /consumers/{integrationId}
Behaviour
This operation does not delete the consumer record.
- All application links of the consumer are removed and
attributesis cleared entirely (null). - The consumer record, wallet assets (vouchers, coupons, points, referrals) and transaction history are not deleted.
- If the consumer is not found, the endpoint returns
404(Consumer not found!). - Success response:
204 No Content.
Do not treat this endpoint alone as sufficient for a GDPR or KVKK erasure request. Discuss full deletion requirements with the KLP team separately.
Run delete operations with an approval step and an audit trail.
Common pagination contract
Wallet and transaction search requests use lower camel case query parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
integrationId | string | — | Consumer ID |
pageNumber | integer | 1 | Requested page |
pageSize | integer | 20 | Page size |
orderColumn | string | Id | Sort column |
orderType | string | Asc | Asc or Desc |
Use the exact parameter casing shown on this page.
Voucher and coupon searches accept additional filters (see Vouchers and Coupons below): includeExpired (both) and status (coupons only).
Search response envelope:
{
"totalCount": 1,
"result": []
}
Vouchers
Endpoint
GET /consumerwallets/vouchers?integrationId={integrationId}&includeExpired=false&pageNumber=1&pageSize=20&orderColumn=Id&orderType=Asc
| Additional parameter | Type | Default | Description |
|---|---|---|---|
includeExpired | bool | false | When false, vouchers from pools whose award period (awardableUntil) has passed are not listed |
Response item
{
"code": "IV55AFKV",
"status": "Active",
"campaignId": "g8JYWnwRK6-VB8Ti9LvS1w==",
"missionId": null,
"levelId": null,
"rewardId": null,
"expireDate": "2026-11-07T00:00:00+00:00",
"awardableUntil": null,
"activationDate": "2026-02-16T17:23:04.911+00:00",
"date": "2026-02-16T17:23:04.911+00:00",
"clientSessionId": "dcc63efa-d765-4bd1-a39f-171c194035e1",
"contents": []
}
| Field | Type | Description |
|---|---|---|
code | string | Voucher code |
status | VoucherCodeActivityType | Pending, Active, Expired |
campaignId | string? | Set when the voucher comes from a campaign |
missionId | string? | Set when the voucher comes from a gamification mission |
levelId | string? | Set when the voucher comes from a gamification level |
rewardId | string? | Set when the voucher comes from a gamification reward |
expireDate | DateTime? | End of the usage period |
awardableUntil | DateTime? | Last date on which the pool can award vouchers |
activationDate | DateTime | Date from which the voucher can be used |
date | DateTime | Award date |
clientSessionId | Guid? | Session that awarded the voucher |
contents | array? | Pool contents |
Recently added fields in the voucher response have not yet been verified against the live API.
The server calculates status: Pending if activationDate is in the future, Expired if expireDate has passed, and Active otherwise.
Treat voucher codes as sensitive benefits and mask them in telemetry.
Coupons
Endpoint
GET /consumerwallets/coupons?integrationId={integrationId}&includeExpired=false&pageNumber=1&pageSize=20&orderColumn=Id&orderType=Asc
| Additional parameter | Type | Default | Description |
|---|---|---|---|
includeExpired | bool | false | When false, coupons whose expireDate has passed are not listed |
status | CodeActivityType? | — | Status filter. If you pass Expired, expired coupons are returned regardless of includeExpired |
Response item
{
"poolId": "693020781e6f892b14f691c1",
"poolName": "TestPool3",
"codeId": "693020781e6f892b14f691c1-696a80b9b54b7c9171348214",
"code": "4VNABX9B4NFP4K",
"status": "Active",
"campaignId": "9DbEPsyIY7mYu5tqDv7dTQ==",
"missionId": null,
"levelId": null,
"rewardId": null,
"usageLimit": null,
"usageCount": 0,
"startDate": "2026-01-06T00:00:00+00:00",
"expireDate": null,
"acquisitionDate": "2026-02-16T14:50:04.007+00:00",
"contents": []
}
The fields missionId, levelId, rewardId (set for coupons that come from gamification) and acquisitionDate (the date the consumer acquired the coupon) have not yet been verified against the live API.
Code status enum:
Active
Inactive
Redeemed
Expired
ActivationPending
Handle unknown status values in a forward-compatible way.
Loyalty point balances
Endpoint
GET /consumerwallets/{integrationId}/points
Response
[
{
"programId": "ZYaNScbtVVxDvaRIAEbtXA==",
"programName": "Test Loyalty Program 1",
"totalPoints": 10,
"subLedgers": []
}
]
| Field | Type |
|---|---|
programId | string |
programName | string? |
totalPoints | decimal |
subLedgers | array |
subLedgers[i].points | decimal |
subLedgers[i].subLedger | string? |
Interpret subLedger: null as the Main Ledger.
Loyalty program transactions
Endpoint
GET /consumerwallets/programtransactions?programId={programId}&integrationId={integrationId}&pageNumber=1&pageSize=20&orderColumn=Id&orderType=Asc
Response item
{
"date": "2026-02-16T17:34:20.573+00:00",
"subLedger": null,
"point": 10,
"reason": "Kazan Kazan",
"activationDate": "2026-02-16T17:34:30.573+00:00",
"expirationDate": null,
"loyaltyProgramPointEffectType": "Award"
}
Point effect enum:
Redeem
Award
Expire
Do not derive the transaction type from the sign of the point value. Treat the enum as the source of truth.
Referrals
Endpoint
GET /consumerwallets/referrals?integrationId={integrationId}&pageNumber=1&pageSize=20&orderColumn=Id&orderType=Asc
Response item
{
"poolId": "6908555e5308cd2540202ae3",
"codeId": "6908555e5308cd2540202ae3-690855697f49535f8e8070cf",
"code": "FX9WFX4A",
"status": "Active",
"campaignId": "g8JYWnwRK6-VB8Ti9LvS1w==",
"usageLimit": 1,
"usageCount": 0,
"startDate": "2025-11-01T00:00:00+00:00",
"expireDate": null,
"usageList": []
}
usageList[i]:
{
"date": "2026-02-15T12:00:00Z",
"integrationId": "referred-consumer-id"
}
Referral codes and referred consumer identities are subject to your logging and privacy policy.
Tier programs
This endpoint has not yet been verified against the live API. Values in the example are representative.
Replaces the former GET /consumerwallets/{integrationId}/programTiers endpoint.
Endpoint
GET /consumerwallets/{integrationId}/tierprograms?types=Points&types=Attribute&includeOnlyActive=true
Query
| Parameter | Type | Default | Description |
|---|---|---|---|
types | OrganizationTierProgramType[]? | — (all) | Tier program type filter. Repeat the parameter to pass multiple values |
includeOnlyActive | bool | false | When true, only active tier programs are returned |
OrganizationTierProgramType:
Points # Tier based on loyalty points
Attribute # Tier based on consumer attributes
Response
[
{
"loyaltyProgramId": "wT0iyGKBaoRiM2-lt5fegA==",
"tierProgramId": "HPSUCwHh4FSxXlmlsCqfiA==",
"loyaltyProgramName": "Test Loyalty Puan",
"tierProgramName": "Puan Seviyeleri",
"type": "Points",
"isActive": true,
"currentValue": 0,
"currentTierId": "26275059-d1fa-4290-82b1-591b70ee9aea",
"currentTier": "t1",
"nextTierId": "8d1c2f5e-0a3b-4c6d-9e7f-1a2b3c4d5e6f",
"nextTier": "t2",
"nextTierThreshold": 50
}
]
| Field | Type | Description |
|---|---|---|
loyaltyProgramId | string? | Can be null for Attribute tier programs |
tierProgramId | string | Tier program identifier |
loyaltyProgramName | string? | |
tierProgramName | string? | |
type | OrganizationTierProgramType | Points or Attribute |
isActive | bool | Whether the tier program is active |
currentValue | decimal | Current points or attribute progress value |
currentTierId / currentTier | Guid? / string? | Current tier |
nextTierId / nextTier | Guid? / string? | Next tier |
nextTierThreshold | decimal? | Threshold for the next tier |
For the top tier, nextTierId, nextTier and nextTierThreshold can be null. If the consumer is not found, the endpoint returns an empty list.
Active goals
Endpoint
GET /goals/active?integrationId={integrationId}&completed=false
Query
| Parameter | Type | Description |
|---|---|---|
integrationId | string? | Consumer ID |
completed | bool | Completion filter |
Response item
{
"goalId": "WoIl2IoXT_dplrE1KbuPjA==",
"name": "Kazan Kazan Goal",
"description": "",
"campaignId": "g8JYWnwRK6-VB8Ti9LvS1w==",
"progress": 10,
"target": 100,
"status": "InProgress",
"startDate": "2026-02-16T16:03:41.313+00:00",
"completionDate": null,
"endDate": "2026-03-14T00:00:00+00:00",
"lastModified": "2026-02-16T16:03:41.313+00:00",
"completionCount": 0,
"lastCompletionDate": null,
"campaignEndDate": "2026-03-14T00:00:00"
}
Goal status enum:
NotStarted
InProgress
Completed
Expired
Consumer transaction search
Endpoint
GET /transactions/search?integrationId={integrationId}&pageNumber=1&pageSize=20&orderColumn=Id&orderType=Asc
This endpoint searches the consumer's effect transaction history.
Response
{
"totalCount": 1,
"result": [
{
"eventId": null,
"clientSessionId": "dcc63efa-d765-4bd1-a39f-171c194035e1",
"effect": {
"campaignId": "9DbEPsyIY7mYu5tqDv7dTQ==",
"rulesetId": "b3LxCEAt2dWQEpfLfYfyVA==",
"ruleId": "6e4520f2-46c4-4bd5-b2ab-b9a3f1716be4",
"ruleName": "testrule",
"ruleIndex": 2,
"id": "089a5d28-926c-41b8-9fc0-97786eb0cc6d",
"name": "TestPool3",
"actionType": "GiveCouponCode",
"detail": {
"effectTransactionId": "b98ecde1-1ede-45b1-973f-e45706944333",
"couponCode": {
"poolId": "693020781e6f892b14f691c1",
"lotId": "696a80b4743037e00bec124b",
"id": "693020781e6f892b14f691c1-696a80b9b54b7c9171348212",
"code": "FWEPDFKLJQ97KB",
"activationDate": "2026-02-16T14:50:04.007+00:00",
"type": "Award"
}
}
},
"name": "TestPool3",
"createdDate": "2026-02-16T14:49:54.032+00:00"
}
]
}
Recently added fields in the transaction response have not yet been verified against the live API.
eventId (Guid?) and clientSessionId (Guid?) identify the event or session that produced the transaction. Use these fields for reconciliation. See Events and Sessions.
You can use transaction search for reconciliation, support and audit. Mask code values in any logs outside the UI.
SDK current-consumer (/me) endpoints
These endpoints are used by the KLP SDKs; backends always use the integrationId-based endpoints.
The /me endpoints have not yet been verified against the live API.
The frontend and mobile SDKs resolve the consumer identity from the JWT and call the /me variants below. Request and response models are the same as the corresponding backend endpoint; the only difference is that integrationId is omitted from the path, query and body. For authentication and signing rules, see Mobile SDK authentication in Authentication and security.
Backend endpoint (X-Api-Key) | SDK endpoint |
|---|---|
POST /consumers/upsert | POST /consumers/me/upsert |
PUT /consumers/upsert/organization | PUT /consumers/me/upsert/organization |
GET /consumers/{integrationId}/profile | GET /consumers/me/profile |
GET /consumers/getorinsert | GET /consumers/me/getorinsert |
PUT /consumers/{integrationId}/session/{sessionId} | PUT /consumers/me/session/{sessionId} |
GET /consumers/session/{sessionId}/detail/{integrationId} | GET /consumers/me/session/{sessionId}/detail |
DELETE /consumers/{integrationId} | DELETE /consumers/me |
POST /events/{integrationId}/trigger | POST /events/me/trigger |
GET /consumerwallets/vouchers | GET /consumerwallets/me/vouchers |
GET /consumerwallets/coupons | GET /consumerwallets/me/coupons |
GET /consumerwallets/{integrationId}/points | GET /consumerwallets/me/points |
GET /consumerwallets/programtransactions | GET /consumerwallets/me/programtransactions |
GET /consumerwallets/referrals | GET /consumerwallets/me/referrals |
GET /consumerwallets/{integrationId}/tierprograms | GET /consumerwallets/me/tierprograms |
GET /goals/active | GET /goals/me/active |
GET /transactions/search | GET /transactions/me/search |
POST /consumercouponcodes/burn | POST /consumercouponcodes/me/burn |
Session cancel and refund have no /me variant; perform these operations from your backend.
Get or insert consumer
This endpoint has not yet been verified against the live API. Values in the example are representative.
GET /consumers/getorinsert?integrationId={integrationId}&onlyIfExists=false&decryptAttributes=true
| Parameter | Type | Default | Description |
|---|---|---|---|
integrationId | string | — (required) | Consumer ID |
onlyIfExists | bool | false | When true, the consumer is not created if it does not exist |
decryptAttributes | bool | true | Returns attributes that are stored encrypted in decrypted form |
Behaviour:
- If the consumer does not exist and
onlyIfExists=false: the consumer is created and returned. - If the consumer exists but is not linked to this application and
onlyIfExists=false: the consumer is linked to the application and returned. - If the consumer is linked to this application:
latestActivityDateis updated and the consumer is returned. - If
onlyIfExists=trueand the consumer does not exist or is not linked to the application:204 No Content(no body). - The rule engine does not run.
Response:
{
"id": "6d1f0a52-3b7e-4f0e-9c47-2a1e8b5c9d10",
"integrationId": "515ace2c-e89b-4307-a1a7-946f1622e412",
"environmentType": "Live",
"createdDate": "2026-02-16T18:26:25.299+00:00",
"latestActivityDate": "2026-10-19T09:00:00+00:00",
"closedSessions": 0,
"discountedSessions": 0,
"totalDiscountAmount": 0,
"totalSessionAmount": 0,
"attributes": {}
}
id is a KLP-generated identifier. Always identify the consumer by integrationId.
Burn coupon code
This endpoint has not yet been verified against the live API. Values in the example are representative.
Marks a coupon code in the consumer's wallet as redeemed when it is used outside KLP (for example, at a POS).
POST /consumercouponcodes/burn
X-Api-Key: <API_KEY>
Content-Type: application/json
{
"Code": "4VNABX9B4NFP4K",
"OrganizationConsumerIntegrationId": "515ace2c-e89b-4307-a1a7-946f1622e412"
}
| Field | Type | Required |
|---|---|---|
Code | string | Yes |
OrganizationConsumerIntegrationId | string | Yes (backend). Not sent to the SDK /me/burn endpoint |
Behaviour:
- The code is redeemed, the consumer's coupon usage count is incremented, and a transaction record containing a
RedeemCouponCodeeffect (eventType: burn_code) is created. This record appears in/transactions/searchresults. - Success:
200 OK, no body.
The endpoint also returns 200 OK if the code does not belong to this consumer or the redemption fails; it does not return an error. A 200 response does not guarantee that the code was burned. To confirm the result, check the coupon status / usageCount through /consumerwallets/coupons, or use transaction search.
Loyalty programs
This endpoint has not yet been verified against the live API. Values in the example are representative.
GET /loyaltyprograms/list
Returns the application's loyalty programs and their contents.
[
{
"id": "ZYaNScbtVVxDvaRIAEbtXA==",
"name": "Test Loyalty Program 1",
"subLedgers": ["Bonus"],
"contents": [
{ "key": "Title", "value": "Kazan Kazan" }
]
}
]
| Field | Type |
|---|---|
id | string |
name | string? |
subLedgers | string[]? |
contents[i].key / .value | string / string? |
This response does not include tier data. Use /tierprograms/list for tier definitions.
Tier program definitions
This endpoint has not yet been verified against the live API. Values in the example are representative.
GET /tierprograms/list
Returns the application's tier programs, their levels, level rewards and contents. This is definition (catalog) data and is not consumer-specific. For a consumer's current tier, use /consumerwallets/{integrationId}/tierprograms.
[
{
"loyaltyProgramId": "wT0iyGKBaoRiM2-lt5fegA==",
"loyaltyProgramName": "Test Loyalty Puan",
"tierProgramId": "HPSUCwHh4FSxXlmlsCqfiA==",
"tierProgramName": "Puan Seviyeleri",
"type": "Points",
"isActive": true,
"levels": [
{
"levelId": "26275059-d1fa-4290-82b1-591b70ee9aea",
"order": 1,
"name": "t1",
"threshold": 0,
"isSystemDefined": true,
"rewards": [],
"contents": []
}
]
}
]
| Field | Type |
|---|---|
loyaltyProgramId / loyaltyProgramName | string? (can be null for the Attribute type) |
tierProgramId / tierProgramName | string / string? |
type | Points / Attribute |
isActive | bool |
levels[i].levelId | Guid |
levels[i].order | int |
levels[i].name | string? |
levels[i].threshold | int |
levels[i].isSystemDefined | bool |
levels[i].rewards[j].id | Guid |
levels[i].rewards[j].contents / levels[i].contents | { key, value }[] |
Because this is definition data, you can cache it with a long TTL.
Authentication and error contract
All endpoints return the following:
| Case | HTTP | Body |
|---|---|---|
| Missing header | 401 | Empty body |
| Invalid API key | 404 | Code: 3001 |
| Consumer not found | 404 | Code: 2002 |
See Authentication and security for details.
Caching
| Data | Recommendation |
|---|---|
| Consumer Profile | Short TTL; invalidate after upsert |
| Points | Short TTL; refresh after award or redeem |
| Coupon/Voucher | Very short TTL or no cache |
| Program Transactions | Pagination caching is acceptable |
| Referrals | Short TTL |
| Goals/Tiers | Short TTL; invalidate after an effect |
| Transaction Search | Pagination caching for support and audit use |
Do not make redemption decisions based on stale wallet data.
Privacy and data protection
- Maintain an allow-list of consumer attributes.
- Classify PII fields.
- Disable or redact API body logging.
- Mask coupon, voucher and referral codes.
- For delete (attribute clearing), verify identity and keep an audit trail. Remember that delete does not remove wallet or transaction data.
- Confirm retention and deletion behaviour with your legal and security teams.
Test checklist
- Upsert creates consumer
- Organization attributes upsert / 204
- Organization upsert with application-scoped key / 400
- Typed (non-string) profile attributes
- Merge semantics with
OverWriteConsumer: false - Overwrite semantics with
OverWriteConsumer: true -
RunRuleEngine: false -
RunRuleEngine: true - Profile success
- Consumer not found / Code 2002
- Delete / 204 (attributes are cleared, wallet and transactions remain)
- Repeated delete behavior
- Get-or-insert: new consumer / existing consumer /
onlyIfExists - Coupon burn and transaction record
- Burning another consumer's coupon (returns 200, has no effect)
- Loyalty program and tier program lists
- SDK
/meendpoints - Different
integrationIdin an SDK request / 403 - Pagination defaults
- Query parameter casing
- Voucher list
- Voucher/coupon
includeExpired - Voucher status (
Pending/Active/Expired) - Coupon statuses
- Decimal points
- Main ledger null sub-ledger
- Point transaction enum
- Referral usage list
-
tierprogramsendpoint (the formerprogramTiersendpoint no longer exists) - Tier program
types/includeOnlyActivefilters - Attribute-type tier program (null
loyaltyProgramId) - Top-tier null fields
- Active/inactive completed goal queries
- Transaction search pagination
- Sensitive code redaction
- Invalid API key / Code 3001
- Missing API key / 401