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)

Retrieves the sites' checkout settings.


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

import { checkoutSettings } from 'wix-ecom-backend';

export async function myGetCheckoutSettingsFunction() {
  try {
    const settings = await checkoutSettings.getCheckoutSettings();
    console.log('Success! CheckoutSettings:', settings);
    return settings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/

Get checkout settings without elevated permissions

import { Permissions, webMethod } from 'wix-web-module';
import { checkoutSettings } from 'wix-ecom-backend';

export const myGetCheckoutSettingsFunction = webMethod(Permissions.Anyone, async () => {
  try {
    const settings = await checkoutSettings.getCheckoutSettings();
    console.log('Success! CheckoutSettings:', settings);
    return settings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});

/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/


Get checkout settings without elevated permissions (export from backend code)

import { Permissions, webMethod } from 'wix-web-module';
import { checkoutSettings } from 'wix-ecom-backend';
import { elevate } from 'wix-auth';

export const myGetCheckoutSettingsFunction = webMethod(Permissions.Anyone, async () => {
  try {
    const elevatedGetCheckoutSettings = elevate(checkoutSettings.getCheckoutSettings);
    const getCheckoutSettings = await elevatedGetCheckoutSettings();
    console.log('Success! Checkout settings:', getCheckoutSettings);
    return getCheckoutSettings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});
/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/


Get checkout settings with elevated permissions 

getCheckoutSettings

GetCheckoutSettingsResponse

checkoutSettings

CheckoutSettings

options

UpdateCheckoutSettingsOptions

Updates the sites' checkout settings.


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

import { checkoutSettings } from 'wix-ecom-backend';

/* Sample update value:
{
  "checkoutSettingsInfo": {
        "checkoutFields": {
            "mitEnabled": false
        }
    }
}
*/

export async function myUpdateCheckoutSettingsFunction(checkoutSettingsInfo) {
  try {
    const settings = await checkoutSettings.updateCheckoutSettings(checkoutSettingsInfo);
    console.log('Success! Updated checkout settings:', settings);
    return settings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/


Update checkout settings (dashboard page code)

import { Permissions, webMethod } from 'wix-web-module';
import { checkoutSettings } from 'wix-ecom-backend';
import { elevate } from 'wix-auth';

/* Sample update value:
{
  "checkoutSettingsInfo": {
        "checkoutFields": {
            "mitEnabled": false
        }
    }
}
*/

export const myUpdateCheckoutSettingsFunction = webMethod(Permissions.Admin, async (checkoutSettingsInfo) => {
  try {
    const elevatedUpdateCheckoutSettings = elevate(checkoutSettings.updateCheckoutSettings);
    const settings = await elevatedUpdateCheckoutSettings(checkoutSettingsInfo);
    console.log('Success! Updated checkout settings:', settings);
    return settings;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});

/* Promise resolves to:
{
  "checkoutSettings": {
    "checkoutPolicies": {
      "termsAndConditions": {
        "visible": true,
        "content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
      },
      "privacyPolicy": {
        "visible": true,
        "content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
      },
      "returnPolicy": {
        "visible": true,
        "content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
      },
      "digitalItemPolicy": {
        "visible": false,
        "content": ""
      },
      "contactUs": {
        "visible": true,
        "content": "Email: accs@mail.com"
      },
      "customPolicy": {
        "visible": true,
        "content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
        "title": "Orders and Payments"
      }
    },
    "checkoutFields": {
      "subscriptionCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "policyAgreementCheckbox": {
        "visible": true,
        "checkedByDefault": false
      },
      "giftCardRedeemEnabled": true,
      "mitEnabled": false
    }
  }
}
*/


Update checkout settings (export from backend code)

updateCheckoutSettings

UpdateCheckoutSettingsResponse

---
title: Introduction
---
# Introduction

&nbsp;

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
 Developer Preview
 
 APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production. <a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.
</div>

&nbsp;

With the Checkout Settings API, you can retrieve and update the checkout settings for sites that have installed your app. These settings include adding or removing eCommerce policies, and setting checkbox behavior for a checkout.

Policies will appear as clickable links in the footer of your checkout, while checkboxes can be found when selecting the payment method. The policy text can be read in a pop-up window if you click the policy name. The default checkout settings are provided when you first create a Wix eCommerce site.

## Terminology

- **Checkout:** The second stage of the eCommerce purchase flow: cart, checkout, order. A checkout holds information about items to be purchased, price and tax summaries, shipping and billing info, any applied discounts, and more.
- **Policy:** Set of guidelines, rules, or principles established by an organization or authority to govern behavior, decision-making, and specific actions.


## Before you begin

It’s important to note the following points before starting to code:

- To use the Checkout Settings API, import `{ checkoutSettings }` from the `wix-ecom-backend` module:

```javascript
import { checkoutSettings } from 'wix-ecom-backend';
```

## Permissions information

The following functions in the Checkout Settings API are restricted and only run if
you elevate permissions using the `wix-auth` [`elevate()`](https://dev.wix.com/docs/velo/api-reference/wix-auth/elevate) function:

- [`updateCheckoutSettings()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/checkout-settings/update-checkout-settings)

<blockquote class='warning'>

Warning:
Elevating a function allows it to be called by any site visitor.
Exercise caution to prevent security vulnerabilities.

</blockquote>

velo-deps_wix-ecom-backend_checkout-settings

Alignment

CheckboxField

Whether the checkbox is checked by default.

checkedByDefault

boolean

Whether the checkbox is visible to the customer.

visible

CheckoutBrand

header

CheckoutHeader

CheckoutFields

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

Alignment within the header.

>**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left.

alignment

Whether to display the 'Checkout' label within the header.
Depending on the locale, the label may be translated.

displayCheckoutLabel

Specifications for when a logo is included in the header.

logo

Logo

Textual content to be included in the header (e.g. Business Name)
TODO: update maxLength validation once limitation is known

text

string

CheckoutPolicies

contactUs

ContactUsPolicy

customPolicy

CustomCheckoutPolicy

digitalItemPolicy

DigitalItemPolicy

privacyPolicy

PrivacyPolicy

returnPolicy

ReturnPolicy

termsAndConditions

TermsAndConditionsPolicy

Date and time the checkout settings were created.

_createdDate

Date and time the checkout settings were updated.

_updatedDate

Settings that apply to checkout fields and the checkout process.

checkoutFields

checkoutPolicies

content

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`

size

LogoSize

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`

updateCheckoutSettings( )