search-loyalty-events-request.md

Search Loyalty Events Request

A request to search for loyalty events.

Structure

SearchLoyaltyEventsRequest

Fields

Name	Type	Tags	Description
query	LoyaltyEventQuery | undefined	Optional	Represents a query used to search for loyalty events.
limit	number | undefined	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
cursor	string | undefined	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.

Example (as JSON)

{
  "limit": 30,
  "query": {
    "filter": {
      "order_filter": {
        "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY"
      }
    }
  }
}