queryLoyaltyAccounts( )


Creates a query to retrieve a list of accounts.

The queryLoyaltyAccounts() method builds a query to retrieve a list of events and returns a LoyaltyAccountsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() method.

You can refine the query by chaining LoyaltyAccountsQueryBuilder methods onto the query. LoyaltyAccountsQueryBuilder methods enable you to sort, filter, and control the results queryLoyaltyAccounts() returns.

queryLoyaltyAccounts() runs with these LoyaltyAccountsQueryBuilder defaults, which you can override:

  • skip(0)
  • limit(50)
  • descending("_createdDate")

The methods that are chained to queryLoyaltyAccounts() are applied in the order they're called. For example, if you apply ascending("points.balance") and then descending("points.earned"), the results are sorted first by the balance, and then, if there are multiple results with the same balance, the items are sorted by earned points.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
contactIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
memberIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
points.balanceeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.earnedeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.adjustedeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.redeemedeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.expiredeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
lastActivityDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
tier.ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
contact.ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
pointsExpiration.expirationDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
pointsExpiration.expiringPointsAmounteq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?