Search Loyalty Events - Automate.ax

square.searchLoyaltyEvents searches for loyalty events.

Example

automations/square-search-loyalty-events.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Search Square Loyalty Events", () => {
  onDashboardRun({ title: "Search Square Loyalty Events" })

  square.searchLoyaltyEvents({
    query: {
      filter: {
        orderFilter: {
          orderId: "PyATxhYLfsMqpVkcKJITPydgEYfZY",
        },
      },
    },
    limit: 30,
  })
})

Inputs

Every input accepts a compatible signal. It requires LOYALTY_READ.

Field	Type	Required	Default	Description
`query`	`Square.LoyaltyEventQuery`	No	—	A set of one or more predefined query filters to apply when searching for loyalty events. The endpoint performs a logical AND to evaluate multiple filters and performs a logical OR on arrays that specifies multiple field values.
`limit`	`number`	No	—	The maximum number of results to include in the response. The last page might contain fewer events. The default is 30 events.
`cursor`	`string`	No	—	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.

Use the official SearchLoyaltyEvents reference for provider field semantics and limits.

Output

Returns the official Square.SearchLoyaltyEventsResponse response as a codec-safe object. Square integer money amounts remain bigint values.