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:
With the Reports API you can create and manage reports for items that are reported by site visitors, such as comments.
With the Reports API, you can:
(December 17, 2024)
The Wix Accounts API enables Channel and Enterprise partners to create Wix accounts and retrieve account data.
(December 15, 2024)
The Wix Account Invites API enables you to invite individuals to join your Wix account as team members, so you can expand your team and delegate account responsibilities efficiently.
(December 15, 2024)
The Users API enables account owners to manage their account's team members access to account assets.
Note that this API manages team members within accounts, and is not intended for managing customer access to individual sites.
(December 15, 2024)
The Wix Site Invites API allows you to manage the invitation process for collaborators on a Wix site.
(December 15, 2024)
The Contributors API allows account managers to retrieve a list of contributors for a given site and to change the contributors' roles for the site.
(December 15, 2024)
The Tips APIs allow you to manage tips in the eCommerce ecosystem, including previewing tips, managing calculation settings, and identifying tippable staff.
The Tips APIs include:
(December 11, 2024)
You can now set attendance information for multiple booking sessions in bulk using the bulkSetAttendance() method.
(December 9, 2024)
The Wix Multilingual Translation Schema & Translation Content APIs now include error message articles:
(December 8, 2024)
The Social Media API allows you to track when a loyalty customer follows a social media channel.
With the Social Media API, you can:
(December 6, 2024)
The Calendar APIs allow you to manage business calendars efficiently. The APIs are built around schedules, which group related events like classes or meetings. The schedule time frame provides quick access to the timing of the first and last event in a schedule. Subscribing to the event view ensures you stay informed about scheduling updates, while participation tracking lets you monitor attendance.
The Calendar APIs include:
(December 5, 2024)
The Resources V2 API lets you manage Bookings resources like rooms, equipment, or other assets businesses need to offer services to customers. Customers can only book resources if they’re associated with a defined resource type.
(December 5, 2024)
The Resource Types V2 API allows you to define and manage resource classifications for Bookings resources. Using resource types helps businesses prevent double bookings by ensuring proper resource allocation.
(December 5, 2024)
The Staff Members API allows you to manage staff who provide Bookings services, including defining their availability and setting their working hours.
(December 5, 2024)
The Wix Data Backups API enables you to create and manage backups of the live content in a Wix site's collections. Functionality includes:
(December 2, 2024)
The Comments API has new methods:
HIDDEN
status.HIDDEN
status.(November 29, 2024)
The Recommendations Service Plugin (formerly SPI) allows you to integrate your service with Wix to provide advanced recommendation algorithms that allow Wix merchants to provide tailored product recommendations to their customers.
(November 18, 2024)
The Domain Search APIs allow you to retrieve suggestions for domains that are spot-on for your customers' sites and check the availability of a specific domain.
(November 14, 2024)
The Multilingual Translation APIs allow you to add multilingual support to your app, enabling Wix users to translate and manage their content across different locales. These APIs include three services: Translation Schema, Translation Content, and Translation Published Content.
The Translation Schema API allows you to manage the schema for translating site content.
With the Translation Schema API, you can:
The Translation Content API allows you to access and manage a site's translation content based on the defined translation schema.
With the Translation Content API, you can:
The Translation Published Content API allows you to query translated content that has been marked as ready to publish.
With the Translation Published Content API, you can:
(November 11, 2024)
The Domain DNS API enables you to manage DNS zones in Google's Cloud DNS,to connect domains that you've registered through Wix to non-Wix websites, and to manage DNS records for external domains that are connected by nameservers to Wix sites.
(November 11, 2024)
The Connected Domains APIs enables you to connect domains that haven't been registered through Wix to a Wix site.
(November 7, 2024)
The Booking Fees API enables you to calculate and manage fees (currently only cancellation fees) for bookings, ensuring transparent and consistent pricing for customers.
(October 31, 2024)
A booking policy snapshot is the version of a service's booking policy at the time a booking is created. This is important since a policy may change after the customer books the service. The Booking Policy Snapshots API allows you to retrieve policy snapshots.
(October 31, 2024)
Booking policies are a set of rules that define how customers can book a service, including:
(October 31, 2024)
You can now mark recordings as deleted.
(October 28, 2024)
The Data Extension Schema API enables you to create and update user-defined schemas for a specific site, and retrieve all the data extension schemas installed on a specific site, dependent on your permissions.
A data extension schema is the JSON schema within a schema plugin extension that defines extendedFields
that are added to a Wix API's service entity.
(October 28, 2024)
The following Wix API is no longer in Developer Preview. This means that the API is not subject to breaking changes and can be used in production.
(October 27, 2024)
The Referred Friend API allows you to manage referred friends in your referral program on your Wix site.
With the Referred Friend API, you can:
(October 24, 2024)
The Referring Customers API allows you to manage referring customers on your Wix site.
With the Referring Customers API, you can:
(October 24, 2024)
The Referral Rewards API allows you to retrieve information about referral rewards on your Wix site.
With the Referral Rewards API, you can:
(October 24, 2024)
The Referral Program API allows you to create and manage a referral program for Wix sites.
With the Referral Program API, you can:
(October 24, 2024)
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)
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.
(October 14, 2024)
The Ticket Definitions V2 API has new methods: countTicketDefinitions()
, bulkDeleteTicketDefinitionsByFilter()
, deleteTicketDefinitions()
, reorderTicketDefinitions()
, updateTicketDefinitions()
.
(October 14, 2024)
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.
(October 10, 2024)
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.
(October 10, 2024)
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)
The Form Submissions service plugin (formerly SPI) allows 3rd parties to validate forms on users's sites. The service checks the form field values against various validation rules and throws a specific error message in case of any violations.
(September 30, 2024)
Wix Automations has now released the Triggered Events API in the SDK.
The Triggered Events API lets you report and cancel events in your service. You can then turn these reported events into triggers, which users can use to build automation flows on their site.
(September 29, 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.
(September 29, 2024)
SDK React and Dashboard React have been deprecated. For more information, see:
(September 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.
(September 24, 2024)
The Site Actions API allows you to manage the sites owned by a Wix account.
With the Site Actions API, you can:
(September 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.
(September 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.
(September 22, 2024)
The Earning Rules API allows you to manage earning rules for your loyalty program.
With the Earning Rules API, you can:
(September 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:
(September 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:
(September 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.(September 3, 2024)
App strategy can authenticate a Wix Client with an access token
.
(September 3, 2024)
The SEO Keyword Suggestions service plugin (formerly SPI) introduces the ability to integrate 3rd party SEO keyword services with a Wix site. SEO keyword services include getting remaining search quota and listing keyword suggestions.
(August 29, 2024)
The Async Jobs API provides access to asyncronous jobs across Wix's APIs.
(August 28, 2024)
The Custom Charges Service Plugin (formerly SPI) allows 3rd parties to manage usage-based pricing for their app.
It's endpoints allow users to:
(August 27, 2024)
The External Database Service Plugin (formerly SPI) allows you to integrate your service with Wix to implement custom logic to query and modify items and collections hosted on external platforms.
It's endpoints allow users to:
(August 27, 2024)
The following service plugins have been released:
(August 27, 2024)
Service plugins allow your Wix app to extend the functionality of a Wix site by injecting custom logic into existing app flows or introducing entirely new flows. Learn how to add a Wix-hosted service plugin with the CLI or implement a self-hosted service plugin.
(August 27, 2024)
The Analytics Data API enables developers to access a site's analytics data, specifically site visits, sales, orders, and contact requests.
(August 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 Blog API has new methods: bulkCreateDraftPosts()
and bulkDeleteDraftPosts()
.
(August 13, 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 Machine Translation API allows you to render text from one language to another using machine translation. With this API you can provide translatable content from your code and Wix returns the translated text.
With the Machine Translation API, you can:
(July 24, 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)