queryLoyaltyImports( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of loyalty imports.

The queryLoyaltyImports() function builds a query to retrieve a list of imports and returns a LoyaltyImportsQueryBuilder object.

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

You can refine the query by chaining LoyaltyImportsQueryBuilder functions onto the query. LoyaltyImportsQueryBuilder functions enable you to sort, filter, and control the results queryLoyaltyImports() returns.

queryLoyaltyImports() runs with these LoyaltyImportsQueryBuilder defaults, which you can override:

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

The functions that are chained to queryLoyaltyImports() are applied in the order they're called. For example, if you apply ascending('status') and then descending('_createdDate'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by the created date.

PROPERTYSUPPORTED FILTERS & SORTING
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
statuseq(),ne(),exists(),in(),hasSome(),ascending(),descending()
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Was this helpful?
Yes
No