Search.../
  1. APIs

listRewards( )

Developer Preview

Retrieves a list of rewards.

Description

Only rewards with "active" set to "true" will be retrieved. The list includes rewards that are currently unredeemable due to insufficient points held by any customers.

Syntax

function listRewards(options: ListRewardsOptions): Promise<ListRewardsResponse>

listRewards Parameters

NAME
TYPE
DESCRIPTION
options
Optional
ListRewardsOptions

List options.

Returns

Return Type:

Promise<
ListRewardsResponse
>
NAME
TYPE
DESCRIPTION
pagingMetadata
PagingMetadataV2

Details on the paged set of results returned.

rewards
Array<
Reward
>

Retrieved loyalty rewards.

Was this helpful?

listRewards example

Copy Code
1import { rewards } from 'wix-loyalty.v2';
2  
3 async function listRewards(options) {
4   try {
5     const result = await rewards.listRewards(options);
6

7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13