Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Introduction

The Loyalty Transactions API allows you to query transactions related to account activity.

Transaction are created by Loyalty accounts performing various actions:

- Earning points by making purchases.
- Redeeming points by getting rewards.
- On points adjustment.
- When points are refunded for a previously redeemed reward.
- When points expire.

>**Note:** You can't create transactions, only retrieve them.
Transactions are read-only.

identityType

IdentificationData

WebhookIdentityType

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

data

eventType

The identification type and identity data.

instanceId

MessageEnvelope

value

BoolValue

Empty

Int32Value

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

code

description

ApplicationError

Number of items that couldn't be processed.

totalFailures

Number of items that were successfully processed.

totalSuccesses

Number of failures without details because detailed failure threshold was exceeded.

undetailedFailures

BulkActionMetadata

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Maximum number of items to return in the results.

limit

CursorPaging

Number of items returned in the response.

count

Cursor strings that point to the next page, previous page, or both.

Whether there are more pages to retrieve following the current page.

+ `true`: Another page of results can be retrieved.
+ `false`: This is the last page.

hasNext

CursorPagingMetadata

Filter object in the following format:
`"filter" : {
"fieldName1": "value1",
"fieldName2":{"$operator":"value2"}
}`
Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`

filter

Sort object in the following format:
`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`

sort

CursorQuery

Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.

pagingMethod

Cursor string pointing to the next page in the list of results.

Cursors

Details about the error in case of failure.

Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).

Index of the item within the request array. Allows for correlation between request and response items.

originalIndex

Whether the requested action was successful for this item. When `false`, the `error` field is populated.

success

ItemMetadata

SortOrder

fieldName

order

Sorting

bodyAsJson

ActionEvent

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

eventTime

Unique event ID.
Allows clients to ignore duplicate webhooks.

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

DomainEvent

body

entityAsJson

EntityCreatedEvent

deletedEntityAsJson

EntityDeletedEvent

Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.

currentEntityAsJson

EntityUpdatedEvent

amountAfter

amountBefore

App ID of application that initiated this points adjust.

AdjustInfo

loyaltyTransactions

Determines if entities must be returned in response.

returnEntity

BulkCreateLoyaltyTransactionsRequest

results

BulkCreateLoyaltyTransactionsResponse

Only exists if `returnEntity` was set to true in the request.

BulkLoyaltyTransactionResult

CreateLoyaltyTransactionRequest

CreateLoyaltyTransactionResponse

activityType

ID of the the app responsible for providing the earning points data.

orderId

EarnInfo

ExpireInfo

ID of the loyalty transaction to be retrieved.

loyaltyTransactionId

GetLoyaltyTransactionRequest

GetLoyaltyTransactionResponse

accountId

The number of points earned, adjusted, redeemed, or expired in the transaction.

+ `EARN`: Number of points earned by the customer taking an action. Example: `20`
+ `REDEEM`: The number of points redeemed by the customer for a reward. Example: `-50`
+ `ADJUST`: The number of points refunded for a previously redeemed reward. Examples: `20`, `-30`
+ `REFUND`: The number of points refunded for a previously redeemed reward. Example: `60`
+ `EXPIRE`: The number of points that expired due to customer inactivity for a configured period. Example: `-70`

amount

Date and time the transaction was created.

createdDate

Unique identifier, generated by the client. Used to recognize repeated attempts of the same request. Only present when manually adding points using the [Earn Points](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/earn-points) endpoint.

idempotencyKey

Transaction types.

+ `EARN`: Number of points earned by the customer taking an action. See [Earn points](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/earn-points) for more information.
+ `REDEEM`: The number of points redeemed by the customer for a reward.
+ `ADJUST`: The number of points refunded for a previously redeemed reward. See [Adjust Points](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/adjust-points) for more information.
+ `REFUND`: The number of points refunded for a previously redeemed reward.
+ `EXPIRE`: The number of points that expired due to customer inactivity for a configured period.

transactionType

LoyaltyTransaction

TransactionType

transactionTypeInfo

QueryLoyaltyTransactionsRequest

QueryLoyaltyTransactionsResponse

ID of the specific item that was redeemed in this transaction.

Each reward that is redeemed has a unique `referenceEntityId`.

Get Loyalty Transaction

Permission Scopes