search-loyalty-events-request.md

Search Loyalty Events Request

A request to search for loyalty events.

Structure

SearchLoyaltyEventsRequest

Fields

Name	Type	Tags	Description	Getter	Setter
query	?LoyaltyEventQuery	Optional	Represents a query used to search for loyalty events.	getQuery(): ?LoyaltyEventQuery	setQuery(?LoyaltyEventQuery query): void
limit	?int	Optional	The maximum number of results to include in the response. The last page might contain fewer events. The default is 30 events. Constraints: >= 1, <= 30	getLimit(): ?int	setLimit(?int limit): void
cursor	?string	Optional	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. For more information, see Pagination.	getCursor(): ?string	setCursor(?string cursor): void

Example (as JSON)

{
  "limit": 30,
  "query": {
    "filter": {
      "order_filter": {
        "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY"
      },
      "loyalty_account_filter": {
        "loyalty_account_id": "loyalty_account_id8"
      },
      "type_filter": {
        "types": [
          "ACCUMULATE_PROMOTION_POINTS",
          "ACCUMULATE_POINTS",
          "CREATE_REWARD"
        ]
      },
      "date_time_filter": {
        "created_at": {
          "start_at": "start_at4",
          "end_at": "end_at8"
        }
      },
      "location_filter": {
        "location_ids": [
          "location_ids0",
          "location_ids1",
          "location_ids2"
        ]
      }
    }
  },
  "cursor": "cursor8"
}