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:
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)
@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)
SDK React and Dashboard React have been deprecated. For more information, see:
(Sep 25, 2024)
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)
The Site Actions API allows you to manage the sites owned by a Wix account.
With the Site Actions API, you can:
(Sep 23, 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.
(Sep 22, 2024)
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)
The Earning Rules API allows you to manage earning rules for your loyalty program.
With the Earning Rules API, you can:
(Sep 20, 2024)
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:
(Sep 20, 2024)
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:
(Sep 20, 2024)
The Reservations API now includes a new function:
deleteReservation()
: Deletes a reservation with the HELD status.(September 18, 2024)
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)
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:
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:
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:
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:
The Menus API allows you to manage and customize restaurant menus with the following APIs:
(September 18, 2024)
pricing-plans
The arrangePlans()
function is no longer supported. To avoid breaking changes, remove the function from your code.
(September 12, 2024)
The Notifications V3 API enables you to send predefined notifications to Wix site owners and contributors. You can trigger notifications that users can receive:
To send notifications, create a notification template in the Wix Dev Center, and call the notify()
method.
(September 11, 2024)
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)
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)
App strategy can authenticate a Wix Client with an access token
.
(Sept 3, 2024)
The Async Jobs API provides access to asyncronous jobs across Wix's APIs.
(Aug 28, 2024)
The Analytics Data API enables developers to access a site's analytics data, specifically site visits, sales, orders, and contact requests.
(Aug 26, 2024)
The Analytics Sessions API enables select developers to access session IDs collected from Wix sites, and mark sessions as recorded.
(August 26, 2024)
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:
(July 30, 2024)
The following Domain APIs have been released:
(July 18, 2024)
The Resellers Packages API enables strategic partners to offer paid Wix services to their customers.
(July 17, 2024)
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)
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)
The AdsTxt API allows you to manage digital advertisements on a Wix site using its Ads.txt file.
(June 25, 2024)
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:
(June 18, 2024)
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)
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)
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)
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)
We've updated the Tasks API, which allows you to create and manage tasks on your site. Functionality includes:
(April 9, 2024)
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)
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)
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)
blog
The Blog DraftPosts API allows you to manage unpublished blog posts.
Functionality includes:
(December 31, 2023)
crm
The Tasks API is being temporarily removed in preparation for replacement by a new version.
(December 25, 2023)
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)
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)
The Table Reservations API provides all the functionality required to create and manage restaurant table reservations.
It contains the following APIs:
(December 11, 2023)
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:
(Devember 7, 2023)
business-tools
The Site Properties API provides functionality for managing your site's business information.
Functionality includes:
(October 17, 2023)
members
The Members API provides functionality for creating and managing the members of your site.
Functionality includes:
(September 20, 2023)
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)
forms
The new Wix Forms Submissions API provides functionality for managing the submissions to your forms.
Functionality includes:
Note: This module is in Developer Preview.
(August 24, 2023)
ecom
The new Wix eCom Recommendations API provides functionality for recommending items to your customers.
Functionaly includes:
Note: This module is in Developer Preview.
(August 9, 2023)