In This Article

Release Notes

We're always adding and updating the JavaScript SDK APIs, and we want you to have one place to find all of our latest changes and additions.

We want to hear your feedback! You can help us improve the docs by reporting any issues that you notice. You can report bugs and other feedback by clicking one of these buttons at the bottom of each section:

New Property and Function: Wix Restaurants Reservations API

You can now extend the Wix Restaurants Reservation object with extended fields.

Use the new extendedFields property and updateExtendedFields() function to add and update custom data for Reservation objects.

(October 14, 2024)

New Property and Function: Wix Restaurants Reservation Locations API

You can now extend the Wix Restaurants Reservation Location object with extended fields.

Use the new extendedFields property and updateExtendedFields() function to add and update custom data for Reservation objects.

(October 14, 2024)

The Availability Exceptions API allows you to create and manage availability exceptions for restaurant operations. Availability exceptions are time periods during which your site can’t fulfill orders for the operation.

(Oct 14, 2024)

New Service Plugin: eCommerce Gift Vouchers Provider

The eCommerce Gift Vouchers Provider Service Plugin allows you to integrate with Wix as a gift card service provider, enabling Wix merchants to utilize your gift card functionalities directly on their sites, providing a seamless experience for their customers.

Note that the Wix eCommerce Gift Cards service plugin is renamed here as the Wix eCommerce Gift Vouchers service plugin due to npm package limitations. Individual methods will refer to gift cards rather than gift vouchers.

New Developer Preview API: eCommerce Gift Vouchers

The eCommerce Gift Vouchers API enables clients to retrieve gift card data, apply gift card balances to purchases, and void previously redeemed transactions.

Note that the eCommerce Gift Cards API is renamed here as the Wix eCommerce Gift Vouchers API due to npm package limitations. Individual methods will refer to gift cards rather than gift vouchers.

New Function: Fulfillment Methods API

The Fulfillment Methods API now includes a new getCombinedMethodAvailability() function that retrieves the combined availability of a list of fulfillment methods. The combined availability is a list of times during which one or more of the given fulfillment methods is available, and the types of those fulfillment methods.

(September 30, 2024)

New submodule: `@wix/essentials`

@wix/essentials has a new submodule i18n.

The i18n submodule allows the code in an app's frontend interfaces to access the active language and locale settings for each interface. This allows apps to render their text in the same language and locale that the Wix user has chosen for the site.

(Sep 29, 2024)

Deprecated APIs: SDK React and Dashboard React

SDK React and Dashboard React have been deprecated. For more information, see:

(Sep 25, 2024)

New Function: Pro Gallery API

The Pro Gallery API now includes a new bulkDeleteGalleryItems() function that enables you to delete multiple media items from a gallery. This replaces the newly deprecated deleteGalleryItems() function.

(Sep 24, 2024)

New Release: Account Level Site Actions API

The Site Actions API allows you to manage the sites owned by a Wix account.

With the Site Actions API, you can:

Publish a site.

(Sep 23, 2024)

New Release: Availability Exceptions API

(Sep 22, 2024)

New Function: Reservations API

The Reservations API now includes a new searchReservations() function.

You can use this function to search a site's reservations for a given expression, and to perform data aggregations on a site's reservations.

(Sep 22, 2024)

New Release: Earning Rules API

The Earning Rules API allows you to manage earning rules for your loyalty program.

With the Earning Rules API, you can:

Create loyalty earning rules to set up new rules for earning points.
List earning rules to retrieve all earning rules in your loyalty program.
Bulk create loyalty earning rules to set up multiple earning rules at once.
Update loyalty earning rules to modify existing earning rules.
Delete loyalty earning rules to remove earning rules that are no longer needed.
Delete automation earning rules to remove automated earning rules.

(Sep 20, 2024)

New Release: Loyalty Imports API

The Loyalty Imports API allows you to import loyalty data for existing customers from external sources into your Wix site's loyalty program.

With the Loyalty Imports API, you can:

Create a loyalty import to initiate the import process.
Create a loyalty import file URL to securely upload loyalty data files.
Execute the loyalty import to begin processing the uploaded file.
Get a loyalty import to retrieve details about a specific import.
Get an error file download URL to access error information for failed imports.
Query loyalty imports to retrieve and filter existing loyalty imports.

(Sep 20, 2024)

New Release: Loyalty Checkout API

The Loyalty Checkout API enables you to manage loyalty discounts during the checkout process in your Wix site's ecommerce flow.

With the Loyalty Checkout API, you can:

Apply a discount to checkout to apply a loyalty reward, coupon, or referral reward to a specific checkout. This can include redeeming points for a reward and then applying it, or applying an already redeemed reward.
Query loyalty checkout discounts to retrieve and filter information about existing loyalty checkout discounts, including both redeemed rewards ready for immediate use and potential rewards that require point redemption.

(Sep 20, 2024)

New Function: Reservations API

The Reservations API now includes a new function:

deleteReservation(): Deletes a reservation with the HELD status.

(September 18, 2024)

New Function: Time Slots API

The Time Slots API now includes a new function:

checkTimeSlot(): Checks a restaurant's availability to accommodate a reservation for a given party size in a given time slot.

(September 18, 2024)

New APIs: Wix Restaurants

The new Restaurants API provides all the functionality required to create and manage restaurant operations, service fees, fulfillment methods, and menus.

It contains the following APIs:

Operations API

The Operations API allows you to create, retrieve, and manage operations for restaurants. An operation refers to different services a restaurant may offer. For example, a restaurant may offer a takeaway operation and a catering operation, where each one would work with different time frames, availabilities, and fees.

With the Operations API, you can:

Create, update, and delete operations.
Get, list and query existing operations.

Service Fees API

The Service Fees API allows you to create, retrieve, and manage service fee rules for restaurants and apply them to orders. A service fee is an additional fee that's applied to an order when specified conditions are met.

With the Service Fees API, you can:

Create, update, and delete service fee rules.
Get, list and query existing service fee rules.
Calculate the service fees that should be applied to an order.

Fulfillment Methods API

The Fulfillment Methods API allows you to create, retrieve, and manage fulfillment methods for restaurants. A fulfillment method is a method by which a restaurant can provide its customers their orders.

With the Fulfillment Methods API, you can:

Create, update, and delete fulfillment methods.
Get, list and query existing fulfillment methods.
Retrieve fulfillment methods that are available for a given address.

Menus APIs

The Menus API allows you to manage and customize restaurant menus with the following APIs:

Menus: Create and manage restaurant menus.
Sections: Create and manage menu sections, such as "Appetizers", "Mains", "Desserts", "Drinks" and so on.
Items: Create and manage menu items (dishes).
Item Labels: Create and manage item labels used to display the information about the dishes.
Item Variants: Create and manage pricing for variations of menu items, such as different sizes.
Item Modifiers: Create and manage extra modifiers that can be applied additionally to a selected dish, such as extra condiments.
Item Modifier Groups: Create and manage groups, gathering individual item modifiers that can be used to modify, enhance, or specify existing menu items in an order.

(September 18, 2024)

Removed Function: Pricing Plans API

pricing-plans

The arrangePlans() function is no longer supported. To avoid breaking changes, remove the function from your code.

(September 12, 2024)

New Release: Notifications V3 API

The Notifications V3 API enables you to send predefined notifications to Wix site owners and contributors. You can trigger notifications that users can receive:

In the site feed on the Dashboard.
In the Wix Owner app notification center.
As a mobile push notification from the Wix Owner app.

To send notifications, create a notification template in the Wix Dev Center, and call the notify() method.

(September 11, 2024)

New Release: eCommerce Frontend Module

The new eCommerce Frontend API allows you to interact with the native cart and checkout components on your site.

With the eCommerce Frontend API you can:

(September 11, 2024)

New API: Essentials

The Essentials API contains common functionality that you might need when building apps on the Wix platform. The API includes:

auth: Allows you to work with Wix authentication and permissions.
httpClient: Includes helper functions for making HTTP requests within the Wix platform.

(Sept 3, 2024)

New Capability: AppStrategy

App strategy can authenticate a Wix Client with an access token.

(Sept 3, 2024)

New Release: Async Jobs API

The Async Jobs API provides access to asyncronous jobs across Wix's APIs.

(Aug 28, 2024)

New Release: Analytics Data API

The Analytics Data API enables developers to access a site's analytics data, specifically site visits, sales, orders, and contact requests.

(Aug 26, 2024)

New Release: Analytics Sessions API

The Analytics Sessions API enables select developers to access session IDs collected from Wix sites, and mark sessions as recorded.

(August 26, 2024)

New Release: Account Level B2B Site Transfer API

The B2B Site Transfer API enables strategic partners to transfer a Wix site from a source account to a target account.

(August 19, 2024)

The Marketing Consent API allows your app to manage a site's marketing consents. With the Marketing Consent API, your app can:

Create and update a visitor's marketing consent.
Get a visitor's marketing consent by ID or communication details.
Query visitor marketing consents.
Delete a visitor's marketing consent entirely.

(July 30, 2024)

New Release: Account level Domain APIs

The following Domain APIs have been released:

Registered Domains: Register domains through Wix.
Domain DNS: Manage DNS zones in Google's Cloud DNS.
Connected Domains: Connect domains that haven't been registered through Wix to a Wix site.
Connected Domain Setup Info: Retrieve information for the initial setup of a connected domain.
Domain Search Suggestions: Retrieve suggestions for domains that are spot-on for your customers' sites.
Domain Search Availability: Check the availability of a specific domain.

(July 18, 2024)

New Release: Account level Resellers Packages API

The Resellers Packages API enables strategic partners to offer paid Wix services to their customers.

(July 17, 2024)

New Release: Tags API

Tags are labels attached to entities that allow for data categorization and management. For example, an eCommerce order can have associated tags.

With the tags API you can:

(July 11, 2024)

New Function: Dashboard SDK

dashboard

The Dashboard SDK has 2 new functions:

setPageTitle(). Use this function to set the dashboard page title in your browser tab.
addSitePlugin(). Use this function to add a site plugin to a slot within an app created by Wix.

(June 27, 2024)

New Developer Preview API: AdsTxt API

The AdsTxt API allows you to manage digital advertisements on a Wix site using its Ads.txt file.

(June 25, 2024)

New API: Dashboard Favorite List

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline Wix users' dashboard navigation experience and make important pages quickly accessible.

With the Dashboard Favorite List API, users can:

Create, retrieve, update, and delete their list of dashboard favorites.
Add and delete individual dashboard favorites to and from their list.
Create nested views of collections, developer tools, or other dashboard pages for quick access.
Assign custom titles to favorite pages for easier navigation.

(June 18, 2024)

New Capability: Webhooks

The Wix SDK now includes methods to register callback functions as webhook event handlers. For example, the stores module has a method onProductChanged(). Additionally, the WixClient offers a new webhooks property for processing and verifying Wix webhook events. For a detailed usage example, see Handle Events with Webhooks.

(June 2, 2024)

New Function: Dashboard SDK

dashboard

The Dashboard SDK has a new function called onBeforeUnload(). Use this function on dashboard pages to prompt site builders before leaving a page with unsaved data.

(May 6, 2024)

New Developer Preview API: Published Site URLs API

The Published Site URLs API allows you to access URLs that site contributors can use to access their published site pages, including translated pages.

(April 21, 2024)

New Function: Dashboard SDK

dashboard

The Dashboard SDK has a new function called openMediaManager(). This function allows you to open a Wix Media Manager modal on a dashboard page. Site builders can select one or more the site's media files using the manager. The function returns a list of the selected files when the modal is closed.

openMediaManager() replaces the deprecated openMediaDialog() function.

(April 11, 2024)

New API: Tasks

We've updated the Tasks API, which allows you to create and manage tasks on your site. Functionality includes:

Create,update, and delete tasks.
Get and query tasks.
Count tasks.
Move a task's position in the display.

(April 9, 2024)

New Developer Preview API: Site Editor URLs API

The Editor URLs API allows you to access URLs that site contributors can use to access their site editor and to preview changes to their site before publishing.

(March 21, 2024)

New Function and Component: Dashboard React SDK

dashboard-react

The Dashboard React SDK has two new features:

PageLink: A React component for rendering links to dashboard pages.
usePageLocation(): A React hook that provides access to the currently rendered dashboard page's location data.

(February 12, 2024)

New Function: Dashboard SDK

dashboard

The Dashboard SDK has a new function called getPageUrl(). Use this function to retrieve the URL for a dashboard page using that page's ID.

(February 12, 2024)

New Developer Preview API: Blog Draft Posts

blog

The Blog DraftPosts API allows you to manage unpublished blog posts.

Functionality includes:

Create, update, or delete draft posts.
Get, list, or query draft posts.
Get or list deleted draft posts.
Restore or remove draft posts from the trash bin.

(December 31, 2023)

Temporarily Removed: Tasks API

crm

The Tasks API is being temporarily removed in preparation for replacement by a new version.

(December 25, 2023)

Removed: Workflows API

workflows

The Workflows API is being discontinued and will no longer be supported moving forward. Please remove any code that uses the Workflows API.

(December 19, 2023)

New Function: Media API

media

The Media Manager Files API now includes a new function:

bulkImportFile() imports a bulk of files to the Media Manager using external URLs. This replaces bulkImportFiles() which has been deprecated and will be removed on March 31, 2024.

(December 14, 2023)

New Developer Preview API: Table Reservations

The Table Reservations API provides all the functionality required to create and manage restaurant table reservations.

It contains the following APIs:

Reservations: Creates and manages restaurant table reservations.
Reservation Locations: Provides location information and configures reservation settings for individual restaurants.
Time Slots: Retrieves availability information for time slots at a reservation location.

(December 11, 2023)

New Developer Preview API: Reviews

reviews

The Reviews API allows you to manage reviews for a site's services, content, or products. The review object holds the content of the review, a rating score, images or video media, and information about the author.

Functionality includes:

Creating, deleting, or updating a review.
Getting or querying reviews.

(Devember 7, 2023)

New Developer Preview API: Site Properties

business-tools

The Site Properties API provides functionality for managing your site's business information.

Functionality includes:

Getting a site's properties.
Updating a site's business contact information, business profile, and business schedule.
Updating a site's default consent policy.

(October 17, 2023)

New API: Members

members

The Members API provides functionality for creating and managing the members of your site.

Functionality includes:

Creating, updating, and deleting members.
Clearing information from a member's profile, such as phone numbers and emails.
Retrieving members and their information.
Adding and removing logged in members from your site's community.

(September 20, 2023)

New Fields: Pricing Plans

pricing-plans

The Plans object has a new formId field, which is the ID of the order form associated with a plan at checkout.

The Orders object has a new formData object, which contains the following fields:

formId: the ID of the order form associated with a plan at checkout.
submissionId: the ID of the plan's order form submitted at checkout.
submissionData: the data submitted to the plan's order form at checkout.

(August 31, 2023)

New Developer Preview API: Wix Form Submissions

forms

The new Wix Forms Submissions API provides functionality for managing the submissions to your forms.

Functionality includes:

Creating, updating, or deleting submissions.
Getting or querying submissions.
Counting the number of submissions for a specific form.
Marking submissions as seen.
Confirming submissions.
Getting a media upload URL to use in submissions for forms with fields for uploading files.

Note: This module is in Developer Preview.

(August 24, 2023)

New Developer Preview API: Wix eCom Recommendations

ecom

The new Wix eCom Recommendations API provides functionality for recommending items to your customers.

Functionaly includes:

Listing recommendation algorithms supported in your project.
Getting item recommendations using one or more recommendation algorithms.

Note: This module is in Developer Preview.

(August 9, 2023)

Was this helpful?

Yes