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)

List of order IDs and their associated fulfillments' info.

ordersWithFulfillments

Creates multiple fulfillments for one or more orders.


The `bulkCreateFulfillments()` function returns a Promise that resolves when the fulfillments are created.

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

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

async function bulkCreateFulfillments(ordersWithFulfillments) {
  const response = await wixClient.orderFulfillments.bulkCreateFulfillments(ordersWithFulfillments);
}

bulkCreateFulfillments() with API Key access

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

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

async function bulkCreateFulfillments(ordersWithFulfillments) {
  const response = await wixClient.orderFulfillments.bulkCreateFulfillments(ordersWithFulfillments);
}

bulkCreateFulfillments() with Dashboard app access

bulkCreateFulfillments

BulkCreateFulfillmentResponse

orderId

string

fulfillment

Fulfillment

Creates an order fulfillment.


The `createFulfillment()` function returns a Promise that resolves when the fulfillment is created.

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

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

async function createFulfillment(orderId, fulfillment) {
  const response = await wixClient.orderFulfillments.createFulfillment(orderId, fulfillment);
}

createFulfillment() with API Key access

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

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

async function createFulfillment(orderId, fulfillment) {
  const response = await wixClient.orderFulfillments.createFulfillment(orderId, fulfillment);
}

createFulfillment() with Dashboard app access

createFulfillment

CreateFulfillmentResponse

identifiers

DeleteFulfillmentIdentifiers

Deletes an existing order fulfillment.


The `deleteFulfillment()` function returns a Promise that resolves when the fulfillment is deleted.

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

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

async function deleteFulfillment(identifiers) {
  const response = await wixClient.orderFulfillments.deleteFulfillment(identifiers);
}

deleteFulfillment() with API Key access

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

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

async function deleteFulfillment(identifiers) {
  const response = await wixClient.orderFulfillments.deleteFulfillment(identifiers);
}

deleteFulfillment() with Dashboard app access

deleteFulfillment

DeleteFulfillmentResponse

List of order IDs for which to retrieve fulfillments.

orderIds

Retrieves fulfillments associated with multiple specified orders.


The `listFulfillmentsForMultipleOrders()` function returns a Promise that resolves when the fulfillments are retrieved.

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

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

async function listFulfillmentsForMultipleOrders(orderIds) {
  const response = await wixClient.orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
}

listFulfillmentsForMultipleOrders() with visitor/member access

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

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

async function listFulfillmentsForMultipleOrders(orderIds) {
  const response = await wixClient.orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
}

listFulfillmentsForMultipleOrders() with API Key access

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

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

async function listFulfillmentsForMultipleOrders(orderIds) {
  const response = await wixClient.orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
}

listFulfillmentsForMultipleOrders() with Dashboard app access

listFulfillmentsForMultipleOrders

ListFulfillmentsForMultipleOrdersResponse

Order ID for which to retrieve fulfillments.

Retrieves fulfillments associated with a specified order.


The `listFulfillmentsForSingleOrder()` function returns a Promise that resolves when the fulfillments are retrieved.

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

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

async function listFulfillmentsForSingleOrder(orderId) {
  const response = await wixClient.orderFulfillments.listFulfillmentsForSingleOrder(orderId);
}

listFulfillmentsForSingleOrder() with visitor/member access

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

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

async function listFulfillmentsForSingleOrder(orderId) {
  const response = await wixClient.orderFulfillments.listFulfillmentsForSingleOrder(orderId);
}

listFulfillmentsForSingleOrder() with API Key access

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

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

async function listFulfillmentsForSingleOrder(orderId) {
  const response = await wixClient.orderFulfillments.listFulfillmentsForSingleOrder(orderId);
}

listFulfillmentsForSingleOrder() with Dashboard app access

listFulfillmentsForSingleOrder

ListFulfillmentsForSingleOrderResponse

UpdateFulfillmentIdentifiers

Available options to use when updating a fulfillment.

options

UpdateFulfillmentOptions

Updates a fulfillment's properties.
To update a field's value, include the new value in the `fulfillment` field in the body params.
To remove a field's value, pass `null`.


The `updateFulfillment()` function returns a Promise that resolves when the fulfillment is updated.

> **Note:** Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.

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

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

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

updateFulfillment() with API Key access

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

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

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

updateFulfillment() with Dashboard app access

updateFulfillment

OrderWithFulfillments

Order ID and the orders' associated fulfillments after update.

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

or

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

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

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

ecom_order-fulfillments

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

bulkActionMetadata

results

BulkCreateOrderWithFulfillments

fulfillments

BulkOrderFulfillmentsResult

itemMetadata

ItemMetadata

List of order IDs and their associated fulfillments.

fulfillmentId

orderWithFulfillments

CustomFulfillmentInfo

Custom fulfillment info in key:value form.

fieldsData

Order ID and the order's associated fulfillments after deletion.

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

boolean

customInfo

trackingInfo

Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.

_createdDate

completed

lineItems

Fulfillment status.

Supported values:
+ `"Pending"`
+ `"Accepted"`
+ `"Ready"`
+ `"In_Delivery"`
+ `"Fulfilled"`

status

FulfillmentLineItem

Line item ID (mirrors the ID of the order line item).

Line item quantity.
* If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment.
* If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error is returned.

Min: `1`
Max: `100000`

quantity

FulfillmentTrackingInfo

Shipping provider. Using one of the following shipping providers will allow for auto-filling the tracking link:
* `'fedex'`
* `'ups'`
* `'usps'`
* `'dhl'`
* `'canadaPost'`

shippingProvider

Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation.

trackingLink

trackingNumber

FulfillmentsUpdatedEnvelope

entity

metadata

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

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 fulfillments associated with the order.

OnFulfillmentsUpdatedHandler

event

void

UpdateFulfillmentFulfillment

handler

Triggered when one or more of an order's fulfillments are created, updated, or deleted.

The response contains the order's ID and details about all of its fulfillments following the change.

updateFulfillment( )

Permission Scopes