Setup
To use the Transactions API, install the @wix/loyalty package using npm or Yarn:
Copy
1npm install @wix/loyalty
or
Copy
1yarn add @wix/loyalty
Then import { transactions } from @wix/loyalty:
Copy
1import { transactions } from '@wix/loyalty'
Was this helpful?
Yes
No
getLoyaltyTransaction( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a LoyaltyTransaction.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Loyalty
Read Loyalty
Learn more about permission scopes.
Copy
function getLoyaltyTransaction(loyaltyTransactionId: string): Promise<LoyaltyTransaction>
Method Parameters
loyaltyTransactionIdstringRequired
ID of the LoyaltyTransaction to retrieve.
Returns
Return Type:Promise<LoyaltyTransaction>
Was this helpful?
Yes
No
queryLoyaltyTransactions( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of LoyaltyTransactions, given the provided paging, filtering, and sorting.
Up to 1,000 LoyaltyTransactions can be returned per request.
To learn how to query LoyaltyTransactions, see API Query Language.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
accountId | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
amount | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
transactionType | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
description | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
idempotencyKey | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Loyalty
Read Loyalty
Learn more about permission scopes.
Copy
function queryLoyaltyTransactions(): LoyaltyTransactionsQueryBuilder
Request
This method does not take any parameters
Returns
Return Type:LoyaltyTransactionsQueryBuilder
Was this helpful?
Yes
No