listRewards( )


Retrieves a list of rewards.

The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.

Permissions
Manage Loyalty
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
function listRewards(options: ListRewardsOptions): Promise<ListRewardsResponse>;
Method Parameters
optionsListRewardsOptions

List options.

Returns
Return Type:Promise<ListRewardsResponse>
JavaScript
import { rewards } from "wix-loyalty.v2"; async function listRewards(options) { try { const result = await rewards.listRewards(options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

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

Did this help?