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

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

orderId

string

payments

Adds up to 50 payment records to an order.


The `addPayments()` function returns a Promise that resolves when the payment records are added to an order.

> **Note:** This does **NOT** perform the actual charging - the order is only updated with records of the payments.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function addPayments(orderId, payments) {
  const response = await wixClient.orderTransactions.addPayments(orderId, payments);
}

addPayments() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function addPayments(orderId, payments) {
  const response = await wixClient.orderTransactions.addPayments(orderId, payments);
}

addPayments() with Dashboard app access

addPayments

AddPaymentsResponse

Order and payment IDs for which to update payment status.

paymentAndOrderIds

options

BulkUpdatePaymentStatusesOptions

Updates multiple order payments with a specified status.


The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function bulkUpdatePaymentStatuses(paymentAndOrderIds, options) {
  const response = await wixClient.orderTransactions.bulkUpdatePaymentStatuses(paymentAndOrderIds, options);
}

bulkUpdatePaymentStatuses() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function bulkUpdatePaymentStatuses(paymentAndOrderIds, options) {
  const response = await wixClient.orderTransactions.bulkUpdatePaymentStatuses(paymentAndOrderIds, options);
}

bulkUpdatePaymentStatuses() with Dashboard app access

bulkUpdatePaymentStatuses

BulkUpdatePaymentStatusesResponse

Order IDs for which to retrieve transactions.

orderIds

Retrieves information about payments and refunds associated with all specified orders.


The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function listTransactionsForMultipleOrders(orderIds) {
  const response = await wixClient.orderTransactions.listTransactionsForMultipleOrders(orderIds);
}

listTransactionsForMultipleOrders() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function listTransactionsForMultipleOrders(orderIds) {
  const response = await wixClient.orderTransactions.listTransactionsForMultipleOrders(orderIds);
}

listTransactionsForMultipleOrders() with Dashboard app access

listTransactionsForMultipleOrders

ListTransactionsForMultipleOrdersResponse

Retrieves information about payments and refunds associated with a specified order.


The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function listTransactionsForSingleOrder(orderId) {
  const response = await wixClient.orderTransactions.listTransactionsForSingleOrder(orderId);
}

listTransactionsForSingleOrder() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function listTransactionsForSingleOrder(orderId) {
  const response = await wixClient.orderTransactions.listTransactionsForSingleOrder(orderId);
}

listTransactionsForSingleOrder() with Dashboard app access

listTransactionsForSingleOrder

ListTransactionsForSingleOrderResponse

identifiers

UpdatePaymentStatusIdentifiers

UpdatePaymentStatusOptions

Updates the status of an order's payment.


The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updatePaymentStatus(identifiers, options) {
  const response = await wixClient.orderTransactions.updatePaymentStatus(identifiers, options);
}

updatePaymentStatus() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { orderTransactions } from '@wix/ecom';

const wixClient = createClient({
  modules: { orderTransactions },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updatePaymentStatus(identifiers, options) {
  const response = await wixClient.orderTransactions.updatePaymentStatus(identifiers, options);
}

updatePaymentStatus() with Dashboard app access

updatePaymentStatus

UpdatePaymentStatusResponse

To use the OrderTransactions API, install the `@wix/ecom` package using npm or Yarn:
  ```console
npm install @wix/ecom
```

or

```console
yarn add @wix/ecom
```

Then import `{ orderTransactions }` from `@wix/ecom`:

```js
import { orderTransactions } from '@wix/ecom'
```
  

ecom_order-transactions

Order ID and its associated transactions.

orderTransactions

OrderTransactions

paymentsIds

ApplicationError

code

data

description

BulkActionMetadata

Number of items that couldn't be processed.

totalFailures

number

Number of items that were successfully processed.

totalSuccesses

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

undetailedFailures

BulkPaymentResult

Updated payment. Returned if `return_full_entity` set to `true`.

item

Payment

itemMetadata

ItemMetadata

Whether to return the full payment entity (`results.item`) in the response.

returnFullEntity

boolean

status

TransactionStatus

bulkActionMetadata

results

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

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

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

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

GiftCardPaymentDetails

ID of the app that created the gift card.

appId

giftCardPaymentId

voided

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

anonymousVisitorId

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

memberId

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

wixUserId

identityType

WebhookIdentityType

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

Details about the error in case of failure.

error

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

List of order IDs and their associated transactions.

OnOrderTransactionsUpdatedHandler

event

OrderTransactionsUpdatedEnvelope

void

refunds

PaymentsUpdated

metadata

giftcardPaymentDetails

regularPaymentDetails

Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.

_createdDate

Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.

_updatedDate

amount

Price

Whether refunds for this payment are disabled.
+ `true`: This payment is not refundable.
+ `false`: This payment may be refunded. However, this ultimately depends on the payment provider.

refundDisabled

PaymentAndOrderId

Payment ID.
todo: remove comment once UI will use BulkMarkOrderAsPaid

paymentId

paymentIds

refundIds

formattedAmount

Refund

Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.

listTransactionsForSingleOrder( )