Get Loyalty Advices
GET/client/users/:correlation_id/advices/loyalty
Returns loyalty advices for the current session's account, currently only supports redemption lock. Use this to check whether the member is currently locked from redeeming points.
Request
Query Parameters (optional)
| Key | Type | Description | Allowed Values |
|---|---|---|---|
entity | string | The scope of the lock. Currently only account-level locks are supported. | ACCOUNT |
context | string | The type of action being restricted. Currently only redemption locks are supported. | REDEMPTION |
Response
Returns an array of active lock objects. If no active locks exist, returns an empty array.
| Attribute | Type | Description |
|---|---|---|
accountId | string | The unique identifier of the member account. |
entity | string | The scope of the lock (e.g. ACCOUNT — the lock applies to the entire account). |
context | string | The action being restricted (e.g. REDEMPTION — the member cannot redeem points). |
posture | string | The enforcement action in effect (e.g. BLOCK — the action is fully prevented). |
startTimestamp | string | When the lock was applied, in ISO 8601 format. |
endTimestamp | string | When the lock is scheduled to expire, in ISO 8601 format. May be empty if the lock is indefinite. |
label | string | A human-readable description of the lock. |
channel | string | The channel through which the lock was created (e.g. CUX, CONSOLE). |
source | string | The system that owns this lock record. LOYALTY indicates it was created through the loyalty platform. |
Request
Responses
- 200
200 - Active Redemption Lock