Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Search Loyalty Events Response
A response that contains loyalty events that satisfy the search
criteria, in order by the `created_at` date.
## Structure
`SearchLoyaltyEventsResponse`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `errors` | [`?(Error[])`](/doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
| `events` | [`?(LoyaltyEvent[])`](/doc/models/loyalty-event.md) | Optional | The loyalty events that satisfy the search criteria. | getEvents(): ?array | setEvents(?array events): void |
| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent<br>request. If empty, this is the final response.<br>For more information,<br>see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
## Example (as JSON)
```json
{
"events": [
{
"accumulate_points": {
"loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
"order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY",
"points": 5
},
"created_at": "2020-05-08T22:01:30Z",
"id": "c27c8465-806e-36f2-b4b3-71f5887b5ba8",
"location_id": "P034NEENMD09F",
"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
"source": "LOYALTY_API",
"type": "ACCUMULATE_POINTS"
},
{
"created_at": "2020-05-08T22:01:15Z",
"id": "e4a5cbc3-a4d0-3779-98e9-e578885d9430",
"location_id": "P034NEENMD09F",
"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
"redeem_reward": {
"loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
"order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY",
"reward_id": "d03f79f4-815f-3500-b851-cc1e68a457f9"
},
"source": "LOYALTY_API",
"type": "REDEEM_REWARD"
},
{
"create_reward": {
"loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
"points": -10,
"reward_id": "d03f79f4-815f-3500-b851-cc1e68a457f9"
},
"created_at": "2020-05-08T22:00:44Z",
"id": "5e127479-0b03-3671-ab1e-15faea8b7188",
"loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
"source": "LOYALTY_API",
"type": "CREATE_REWARD"
}
]
}
```