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)

Retrieves the sites' checkout settings.


The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.

import { createClient, OAuthStrategy } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { checkoutSettings } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function getCheckoutSettings() {
  const response = await wixClient.checkoutSettings.getCheckoutSettings();
}

getCheckoutSettings() with visitor/member access

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

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

async function getCheckoutSettings() {
  const response = await wixClient.checkoutSettings.getCheckoutSettings();
}

getCheckoutSettings() with API Key access

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

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

async function getCheckoutSettings() {
  const response = await wixClient.checkoutSettings.getCheckoutSettings();
}

getCheckoutSettings() with Dashboard app access

getCheckoutSettings

GetCheckoutSettingsResponse

checkoutSettings

CheckoutSettings

Updates the sites' checkout settings.


The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.

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

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

async function updateCheckoutSettings(checkoutSettings, options) {
  const response = await wixClient.checkoutSettings.updateCheckoutSettings(checkoutSettings, options);
}

updateCheckoutSettings() with API Key access

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

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

async function updateCheckoutSettings(checkoutSettings, options) {
  const response = await wixClient.checkoutSettings.updateCheckoutSettings(checkoutSettings, options);
}

updateCheckoutSettings() with Dashboard app access

updateCheckoutSettings

UpdateCheckoutSettingsResponse

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

or

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

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

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

ecom_checkout-settings

CheckboxField

Whether the checkbox is checked by default.

checkedByDefault

boolean

Whether the checkbox is visible to the customer.

visible

CheckoutFields

Whether to allow for Auth & Capture transactions. 

Default: `false`

delayCaptureEnabled

Whether the ability to redeem a gift card is enabled.
Default: `false`.

giftCardRedeemEnabled

Whether to allow for MIT transactions.
Default: `false`.

mitEnabled

Policy agreement checkbox.
Default:
- `visible`: `true`,
- `checkedByDefault`: `true`

policyAgreementCheckbox

Subscription checkbox.
Default:
- `visible`: `false`,
- `checkedByDefault`: `false`

subscriptionCheckbox

CheckoutPolicies

contactUs

ContactUsPolicy

customPolicy

CustomCheckoutPolicy

digitalItemPolicy

DigitalItemPolicy

privacyPolicy

PrivacyPolicy

returnPolicy

ReturnPolicy

termsAndConditions

TermsAndConditionsPolicy

Settings that apply to checkout fields and the checkout process.

checkoutFields

checkoutPolicies

CheckoutSettingsUpdatedEnvelope

entity

metadata

EventMetadata

content

string

Whether the contact us policy is visible to the customer in the checkout page. 

Default: `false`

title

Whether the policy is visible to the customer on the checkout page.
Default: `false`.

Whether the digital item policy is visible to the customer in the checkout page. 

Default: `false`

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

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

identityType

WebhookIdentityType

OnCheckoutSettingsUpdatedHandler

event

void

Whether the privacy policy is visible to the customer in the checkout page. 

Default: `false`

Whether the return policy is visible to the customer in the checkout page. 

Default: `false`

Whether the terms & conditions policy is visible to the customer in the checkout page. 

Default: `false`

handler

Triggered when checkout settings are updated.

import { createClient, AppStrategy } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      checkoutSettings,
    },
});

wixClient.checkoutSettings.onCheckoutSettingsUpdated((event) => {
    // handle your event here
});

Setup