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)

instanceId

string

options

AdjustProductInstanceSpecificationsOptions

Upgrades or downgrades a product instance. For example, you can upgrade a
customer's `Business Unlimited Premium` plan to `Business VIP` using this
endpoint.


You must pass the ID of the Wix account that the product instance belongs
to in the header of the call. The call fails, if the product instance and
Wix account don't match.

The customer has immediate access to new features, while loosing access to
features not included in the new service. It's up to the reseller to
decide whether the adjustment affects the customer’s payment.

You can only exchange a product instance with a service of the same type.
Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about
which services belong to the same type.

You must provide either a new `catalogProductId` or a new `billingInfo`
object. The new billing cycle must be supported for the product. Contact the
[Wix B2B sales team](mailto:bizdev@wix.com) for information
about which billing cycles are supported for each product. If you adjust the
billing cycle for a product instance with `RECURRING` payments, you must
also provide `billingInfo.cycleDuration.unit`.

If a removed feature is a requirement for another service, that service
may not be available to the customer any longer. For example, if you downgrade a
`Business Unlimited` plan to `Business Basic`, the site owners won’t be
able to use `Pro eCommerce Features` any longer.

> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function adjustProductInstanceSpecifications(instanceId, options) {
  const response = await wixClient.packages.adjustProductInstanceSpecifications(instanceId, options);
}

adjustProductInstanceSpecifications() with Dashboard app access

adjustProductInstanceSpecifications

AdjustProductInstanceSpecificationsResponse

identifiers

AssignProductInstanceToSiteIdentifiers

AssignProductInstanceToSiteOptions

Assigns a product instance to a site.

 You must pass the ID of the Wix account that the product instance belongs to in the header of the call.

 The customer immediately gains access to features included in the assigned service. It's up to the reseller to decide whether assigning a product instance affects the customer’s payment.

 It's possible to assign a product instance that's already assigned to a site, to a different site without [unassigning](/packages/unassign-product-instance-from-site) it first. But if the call fails in such a situation, the product instance may either remain assigned to the original site or become unassigned. You can confirm the instance's status by [retrieving the relevant package](/packages/get-package).

 **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.

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

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

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

assignProductInstanceToSite() with Dashboard app access

assignProductInstanceToSite

AssignProductInstanceToSiteResponse

CancelPackageOptions

Cancels all product instances included in the package and the customer
immediately looses access to the canceled functionality.


You must pass the ID of the Wix account that the package belongs to in the
header of the call. The call fails, if the package and Wix account don't
match.

If a canceled product instance is a requirement for another Wix service, that
functionality is also no longer available to the customer. For example, if
you cancel a Premium plan, a previously connected domain is automatically
disconnected from the site.

> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function cancelPackage(id, options) {
  const response = await wixClient.packages.cancelPackage(id, options);
}

cancelPackage() with Dashboard app access

cancelPackage

CancelPackageResponse

CancelProductInstanceOptions

Cancels a product instance.


You must pass the ID of the Wix account that the product instance belongs
to in the header of the call. The call fails, if the product instance and
Wix account don't match.

The customer immediately looses access to features included in the
canceled service. It's up to the reseller to decide whether the adjustment
affects the customer’s payment.

If a canceled service is a requirement for another service, that service
may not be available to the customer any longer. For example, if you cancel
a `Combo Plan` plan, a previously connected domain is disconnected
from the site.


> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function cancelProductInstance(instanceId, options) {
  const response = await wixClient.packages.cancelProductInstance(instanceId, options);
}

cancelProductInstance() with Dashboard app access

cancelProductInstance

CancelProductInstanceResponse

CreatePackageOptions

Creates a package of product instances.


<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been replaced with
[Create Package V2](https://dev.wix.com/api/rest/account-level-apis/resellers/packages/create-package-v2)
and will be removed on September 30, 2022.

</blockquote>


> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function createPackage(options) {
  const response = await wixClient.packages.createPackage(options);
}

createPackage() with Dashboard app access

createPackage

CreatePackageResponse

CreatePackageV2Options

Creates a package of product instances.


You must pass the relevant Wix account ID in the header of the call. In
the DIY flow, we recommend to pass the customer's sub-account ID instead
of your main reseller account ID.

You may also pass a Wix site ID for each product in the body of the call.
If you omit the site ID, a floating product instance is created.

When Wix customers purchase a specific paid service or product, Wix may offer
them time-limited free access to a different product. For example, customers
get a voucher for a free 1-year domain registration when purchasing any Wix
Premium plan. If you want to offer your customers the same benefit, create a
package containing the original product first. Then, create a second package
with the additional product. In the second Create Package call, pass the
instance ID of the original product as `referenceProductInstanceId`. This way,
Wix doesn't charge you for the additional product. Make sure that the status
of the referenced product is either `"PENDING"` or `"ACTIVE"`. Note that you
can use each product instance only a single time as reference instance.

You need to pass a `countryCode` to specify where customers can claim
vouchers that may come with a product. Contact the
[Wix B2B sales team](mailto:bizdev@wix.com) to get information about
vouchers and supported locations.

> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function createPackageV2(options) {
  const response = await wixClient.packages.createPackageV2(options);
}

createPackageV2() with Dashboard app access

createPackageV2

Retrieves a package.


You must pass the ID of the Wix account that the package belongs to in the
header of the call. The call fails, if the package and Wix account don't
match.

> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function getPackage(id) {
  const response = await wixClient.packages.getPackage(id);
}

getPackage() with Dashboard app access

getPackage

GetPackageResponse

Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.

query

QueryV2

Retrieves a list of packages, given the provided paging, filtering, and sorting.


You must pass the ID of the Wix account that the packages belong to in the
header of the call. The call returns packages that belong to the parent
account, regardless if you pass the ID of a parent or sub-account. In case
you want to retrieve only packages that belong to a sub-account, you must
pass the sub-account ID as `filter` in the `query` object like this:

```json
{
"query": {
"filter": {
"accountId": {
"$eq": "<SUB_ACCOUNT_ID>"
}
}
}
}
```

Query Packages runs with these defaults, which you can override:

- `createdDate` is sorted in `DESC` order
- `cursorPaging.limit` is `100`

By default `pagingMetadata.cursors` are returned, unless you specifically pass
`query.paging`.

The maximum for `cursorPaging.limit` is `100`.

If you pass a cursor token that you have received in a previous Query Package response,
passing additional sort or filter information results in an invalid cursor
error. Since the received cursor token already holds all the needed information
for sort and filter. Changing the sort and filter properties during the span of
a cursor query isn't supported. But you can provide a different limit.

For field support for filters and sorting,
see [Query Packages: Supported Filters and Sorting](https://dev.wix.com/api/rest/account-level-apis/resellers/supported-filters).

To learn about working with _Query_ endpoints, see
[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).

> **Important**: This call requires an account level API key and cannot be
> authenticated with the standard authorization header.

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

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

async function queryPackages(query) {
  const response = await wixClient.packages.queryPackages(query);
}

queryPackages() with Dashboard app access

queryPackages

QueryPackagesResponse

ID of the product instance to unassign from a site.

UnassignProductInstanceFromSiteOptions

Unassigns a product instance from a site.

 You must pass the ID of the Wix account that the product instance belongs to in the header of the call.

 The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.

 If an unassigned product instance is a requirement for another service, that service may not be available to the customer any longer. For example, if you unassign a `Combo Plan` plan from a site, a previously connected domain is disconnected.

 You can assign floating product instances to sites using the [Assign Product Instance to Site](/packages/assign-product-instance-to-site) method.

 **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.

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

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

async function unassignProductInstanceFromSite(instanceId, options) {
  const response = await wixClient.packages.unassignProductInstanceFromSite(instanceId, options);
}

unassignProductInstanceFromSite() with Dashboard app access

unassignProductInstanceFromSite

UnassignProductInstanceFromSiteResponse

UpdatePackageExternalIdIdentifiers

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

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

async function updatePackageExternalId(identifiers) {
  const response = await wixClient.packages.updatePackageExternalId(identifiers);
}

updatePackageExternalId() with Dashboard app access

updatePackageExternalId

UpdatePackageExternalIdResponse

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

or

```console
yarn add @wix/packages
```

Then import `{ packages }` from `@wix/packages`:

```js
import { packages } from '@wix/packages'
```
  

packages_packages

Information about the billing cycle. Required in case you don't provide a new
`catalogProductId`. The new billing cycle must be supported for the service.
Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
information about a service's supported billing cycles. If
you adjust the billing cycle for a product instance with `RECURRING`
payments, you must also provide `billingInfo.cycleDuration.unit`.

billingInfo

ProductInstanceCycle

ID of the product to replace the original instance. Required in case you don't
provide a new `billingInfo` object.

catalogProductId

Discount code indicating that the reseller provisioned the product instance
during a sale. Ignored when you don't pass a new `catalogProductId` as well.
In case you pass a code that isn't valid, the call succeeds and
no discount is applied to the product instance. Wix doesn't guarantee that a
discount code reduces the price between Wix and the reseller, even when it's
valid. You can't add a discount code after you've created the
product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
more information about supported codes.

Max: 25 characters

discountCode

idempotencyKey

Updated package that includes the adjusted product instance.

package

Package

ID of the product instance to assign to a site.

ID of the site to which the product instance is assigned.

siteId

Updated package that includes the assigned product instance.

Updated package that includes the previously included the canceled product instance.

External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix.

externalId

products

CursorPaging

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

number

Cursors

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

CycleDescriptorType

CycleInterval

Count of units that make up the billing cycle.

count

unit

IntervalIntervalUnit

FailureReason

Failure code.

+ `DELIVERY_TIMEOUT`: The product instance couldn't be created because the Resellers API timed out.
+ `EXTERNAL_FAILURE`: The product instance couldn't be created because an external process failed. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information.

code

FailureReasonFailureReason

message

_createdDate

Date and time the package was last updated.

_updatedDate

Wix account ID. See
[Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
for more details.

accountId

External reference. For example, an external subscription ID.
This field isn't validated by Wix.

Max: 100 characters

Product instances that are included in the package.

Min: 1 product instance
Max: 1000 product instances

productInstances

Paging

Number of items to skip in the current sort order.

offset

PagingMetadataV2

Number of items returned in the response.

Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.

cursors

Flag that indicates the server failed to calculate the `total` field.

tooManyToCount

boolean

Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.

total

ProductInstance

Billing information for the contract between the reseller and Wix.

Date and time the product instance was created.

Date and time the product instance was last updated.

Product ID, as defined in the Wix Premium Product Catalog.
Contact the [Wix B2B sales team](mailto:bizdev@wix.com)
for more details about available Wix services.

Two-letter country code in
[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
format. Specifies where customers can claim vouchers that may come with the
product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more
information about vouchers and supported locations.

countryCode

Discount code indicating that the reseller provisioned the product instance
during a sale. Wix doesn't guarantee that a discount code reduces the
price between Wix and the reseller, even when it's valid. Contact the
[Wix B2B sales team](mailto:bizdev@wix.com) for more information.

Max: 25 characters

Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format.
Used only for instances that don't auto renew at the end of the current billing cycle.

expirationDate

Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`.

failure

ID of the instance of the resold Wix service. **Note:** Differs from the
`catalogProductId`. Allows you to identify different instances of the same
product in a package.

ID of a different product instance that you can use to offer your customers
time-limited free access to an additional product or service. For example,
Wix offers a 1-year free domain registration to all customers who purchase a
Premium plan. The referenced product instance must have either status `"PENDING"` or
`"ACTIVE"`. You can use each product instance only a single time as reference
instance.

referenceProductInstanceId

ID of the Wix site that the product instance is assigned to.
See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites)
for more information.

Status of the product instance.

+ `PENDING`: The product instance isn't yet available to the customer.
+ `ENABLED`: The customer can use the product instance.
+ `CANCELED`: The product instance isn't any longer available to the customer.
+ `FAILED`: The product instance couldn't be delivered successfully and has never been available to the customer.
+ `AWAITING_ACTION`: The product instance isn't yet available to the customer, because an external provider or the customer must take an action.

status

Status

Duration of the billing cycle. Available only for `RECURRING` payments.

cycleDuration

Payment type.
+ `UNKNOWN`: The payment type hasn't been set.
+ `ONE_TIME`: The reseller pays Wix in a single payment.
+ `RECURRING`: The reseller pays Wix on a recurring schedule.

cancelProductInstance( )