We're always adding and updating the Velo APIs, and we want you to have one place to find all of our latest changes and cool additions.
We love hearing your feedback! You can help us improve the docs by reporting any issues that you notice. You can report bugs and other feedback through the following link found at the bottom of each section.
wix-table-reservations.v2
The Reservations API now includes a new function:
deleteReservation()
: Deletes a reservation with the HELD status.(Sep 4, 2024)
wix-restaurants.v2
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:
(August 27, 2024)
wix-analytics-data.v2
The new Analytics Data API enables you to access a site's analytics data, specifically site visits, sales, orders, and contact requests.
(August 26, 2024)
The new Marketing Consent API allows you to manage a site's marketing consents, which are the agreements that visitors consent to when signing up for non-transactional content, such as a newsletter.
(August 25, 2024)
wix-analytics-session.v2
The new Analytics Sessions API allows you to access session IDs collected from Wix sites, and mark sessions as recorded.
(August 25, 2024)
wix-ecom-frontend
The new eCommerce Frontend API allows you to interact with the native cart and checkout components on your site.
As part of this release, wix-stores-frontend
functions will be deprecated and replaced by the new wix-ecom-frontend
module.
With the eCommerce Frontend API you can:
(July 29, 2024)
We've temporarily removed the documentation for web method caching and plan to re-release the feature in the future. This isn't a breaking change. If you already have caching set up, your code will continue to work as expected, but the caching functionality will be disabled.
(July 11, 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 3, 2024)
wix-dashboard
The wix-dashboard
API has 2 new methods:
setPageTitle()
, that sets the dashboard page title in your browser tab.addSitePlugin()
, that adds a site plugin to a slot within an app created by Wix.(June 27, 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 to dashboard navigation experience and make important pages quickly accessible.
With the Dashboard Favorite List API, users can:
(June 18, 2024)
wix-caching-backend
The Cache API allows you to invalidate your function's return value caches that were previously cached with the webMethod()
function of the wix-web-module
.
Use the invalidateCache()
](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) to specify which cached values to invalidate.
Learn more about invalidating your function caches.
(June 16, 2024)
wix-web-module
The webMethod()
function has a new cache
object in the options
parameter that allows you to cache the return values of the functions in your backend code. Define the duration for which you want the return value to be cached with the ttl
field. Use the tags
field to assign identifiers to the cache.
Learn more about function caching in the backend.
(June 16, 2024)
Wix Editor Elements ($w)
We added the following Gallery APIs:
navigateNextEnabled()
: Whether navigation to the next gallery item is enabled.navigatePreviousEnabled()
: Whether navigation to the previous gallery item is enabled.navigateToIndex()
: Navigates to a specific gallery item index.triggerItemClick()
: Triggers a click event on the specified gallery item.onGalleryNavigationStart()
: Adds an event handler that runs when the gallery starts navigation.(June 10, 2024)
wix-loyalty.v2
The Accounts API now includes two new functions:
(June 5, 2024)
wix-loyalty.v2
The Program API now includes three new functions:
(June 5, 2024)
wix-loyalty.v2
The Tiers API now includes two new functions:
(June 5, 2024)
wix-loyalty.v2
The Rewards API now includes two new functions:
(June 5, 2024)
wix-loyalty.v2
The Loyalty Transactions API allows you to query transactions related to account activity. The new API includes:
(June 5, 2024)
wix-loyalty.v2
The following Wix APIs are no longer in Developer Preview. This means that the APIs are not subject to breaking changes and can be used in production.
(June 5, 2024)
wix-events.v2
With the Ticket Definitions API, you can create definitions for tickets. A definition includes various ticket settings, such as fee type, pricing, availability, sale period.
(May 30, 2024)
Wix Editor Elements ($w)
The new WixComments
element is a comment widget available in the Wix App Market to manage comment threads on your Wix site.
The WixComments API allows you to control the comment widget's functionality using code. You can lock the widget, create new comment threads, open and close the comment text input area, and set event handlers for viewing new comments and tracking the total comment count.
(May 20, 2024)
onBeforeUnload
wix-dashboard
We added a new function to wix-dashboard
called onBeforeUnload()
. Use this function on dashboard pages to prompt site builders before leaving a page with unsaved data.
(May 16, 2024)
Wix Editor Elements ($w)
We added following properties to the PanelButton
element:
link
: Sets or gets the element's link to an external site.target
: Sets or gets the target of the element's link.(May 15, 2024)
wix-forum.v2
The Forum categories API has two new functions:
subscribeContactToCategory()
: Subscribes a contact to a specific forum category.unsubscribeContactFromCategory()
: Unsubscribes a contact from a specific forum category.(April 22, 2024)
Wix Editor Elements ($w)
In the MenuContainer element, we removed the onItemMouseIn()
, onItemMouseOut()
, onItemClick()
, and onItemDblClick()
event handlers and the menuItems
property from its documentation. These methods and properties were never supported by MenuContainer
.
(April 17, 2024)
wix-billing-backend
We made the following changes to the Invoices API:
createInvoice()
: Added an optional locale
object to the invoiceFields
parameter. This parameter sets the locale of the customer invoice.
getInvoice()
: Adjusted the list of supported IETF language subtags in the locale.language
property. The previous 4-letter language codes listed in the documentation were never returned in the Invoice
response object. The listed codes have been corrected to display 2-letter language subtags.
(April 16, 2024)
Wix Editor Elements ($w)
The Container
element now contains a new
onKeyPress()
method. This method adds an event handler that's triggered when a key is pressed while the container or one of its child elements is focused.
(April 16, 2024)
wix-dashboard
The openMediaManager()
API 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 API returns a list of the selected files when the modal is closed.
(April 15, 2024)
wix-dashboard
Use the openModal()
API to open a dashboard modal extension on a dashboard page. Use the closeModal()
API to close a currently open modal.
(April 14, 2024)
wix-urls.v2
Wix URLs introduces new APIs that provide developers with access to a site's URLs:
(April 14, 2024)
wix-events.v2
Wix Events introduces new APIs that provide developers with a growing set of services for customizing Events functionality on Wix sites:
(April 4, 2024)
Wix Editor Elements ($w)
Important:
We added the following mobile APIs:
MobileButton
: A button element on a mobile app.MobileContainer
: A container element for repeater items on a mobile app.MobileElement
: Provides basic functionality for mobile elements.MobileImage
: An image element on a mobile app.MobilePicker
: A picker for selecting items on a mobile app.MobileRepeater
: A repeater mobile element used for creating repeating layouts on a mobile app widget.MobileSwitch
: A switch used for a single binary choice on a mobile app.MobileText
: A text element on a mobile app.MobileTextInput
: A text input element for capturing small amounts of text on a mobile app.(April 3, 2024)
wix-mobile
Important:
The Wix Mobile API provides the functionality required to work with your mobile app.
It contains the showAlert() API that creates and opens an alert modal on your mobile app.
(April 3, 2024)
wix-navigate-mobile
Important:
The Wix Navigate Mobile API provides the functionality required to navigate through your mobile app.
It contains the openUrl() API that directs your mobile app to open the specified URL in the device's browser.
(April 3, 2024)
wix-window-frontend
We've added a new mode, "Editor"
, to the viewMode
property of the wix-window-frontend
module.
The viewMode
property retrieves the "Editor"
value when viewing a Wix Blocks built widget in the editor.
(March 18, 2024)
The following elements can be added to Wix Blocks Custom Panels and managed in the Wix Blocks Panel Code:
(March 5, 2024)
The new Velo Action SPI lets you create your own custom action to use in your site's automations. You can create and test code directly in your site dashboard when creating or editing an automation.
(February 14, 2024)
wix-crm-v2
We've updated the Tasks API, which allows you to create and manage tasks on your site. Functionality includes:
(February 13, 2024)
The Dashboard API has two new functions:
observeState()
allows you to react to changes in a dashboard page's environment.getPageUrl()
allows you to retrieve the full URL for any dashboard page.(February 12, 2024)
Wix Editor Elements ($w)
The new WixFormsV2 Element displays customizable forms, collects all the info that a site visitor entered into the form fields, and lets you track all form submissions in the dashboard.
(February 7, 2024)
wix-crm-backend
The Workflows API will be discontinued in the upcoming months. Our team is working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
(February 6, 2024)
wix-pricing-plans.v2
We've updated the wix-pricing-plans.v2
module, which is currently released as a developer preview. Note that the changes break existing code that uses the following functions, which requires updates to your code:
createOfflineOrder()
: memberId
has been taken out of the options
parameter, and is now the second required parameter after planId
.getOfflineOrderPreview()
: memberId
has been taken out of the options
parameter, and is now the second required parameter after planId
.(February 6, 2024)
wix-ecom-backend
Wix eCommerce introduces new functionality to the Orders, Order Transactions, and Order Invoices APIs that provide developers with a growing set of services for customizing eCommerce functionality on Wix sites. The APIs include the following endpoints and webhooks:
As part of this release, several wix-stores-backend functions and events have been deprecated and will be removed on June 30, 2024.
Note: This module is in Developer Preview.
(February 4, 2024)
wix-ecom-backend
The new Checkout Templates API allows you to manage templates to share pre-populated checkouts with customers. When customers then create checkouts from these templates, the new checkouts already include information such as predefined line items, coupons, or other customizations. Functionality includes:
Note: This module is in Developer Preview.
(January 31, 2024)
wix-bookings.v2
We added new APIs in the Wix Bookings Services V2 module that:
(January 29, 2024)
Wix Editor Elements ($w)
We added the new Rich Content Viewer Editor Element that allows you to display rich content created using the Rich Content Editor in the CMS (Content Management System). The content
property is an object used to set and get the content of the Rich Content Viewer element.
(January 11, 2024)
wix-blog-backend
The new Draft Posts API allows you to manage unpublished blog posts. Functionality includes:
Note: This module is in Developer Preview.
(December 31, 2023)
wix-crm.v2
The Tasks API is being temporarily removed in preparation for replacement by a new version.
(December 25, 2023)
wix-workflows.v2
The Workflows v2 API is being discontinued and will no longer be supported moving forward. Please remove any code that uses workflows.v2
.
(December 19, 2023)
Wix Editor Elements ($w)
We added the following new APIs that allow you to customize the [hamburger menu] element:
HamburgerOpenButton
: The icon button that opens the hamburger menu.HamburgerCloseButton
: The icon button that closes the hamburger menu.HamburgerMenuContainer
: The hamburger menu container, which holds the items of an expanded hamburger menu.HamburgerOverlay
: The fullscreen overlay that appears when the hamburger menu is open.(December 18, 2023)
wix-media.v2
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)
wix-pricing-plans-frontend
, wix-pricing-plans-backend
We've updated the wix-pricing-plans-frontend
and wix-pricing-plans-backend
modules to reflect the actual function syntaxes.
wix-pricing-plans-frontend
:
Checkout
:
createOnlineOrder()
: couponCode
has been removed and startDate
has been taken out of the options
parameter.startOnlinePurchase()
: couponCode
has been removed and startDate
has been taken out of the options
parameter.wix-pricing-plans-backend
:
Checkout
:
createOnlineOrder()
: couponCode
and startDate
have been taken out of the options
parameter.The Table Reservations API provides all the functionality required to create and manage restaurant table reservations.
It contains the following APIs:
(December 11, 2023)
wix-inbox.v2
We've updated the wix-inbox.v2
module, which is currently released as a developer preview. Note that the changes break existing code that uses the following functions, which requires updates to your code:
Conversations
:
getOrCreateConversation()
: participantId
has been removed from the options
parameter, and is now the first required parameter.Messages
:
listMessages()
: visibility
has been removed from the options
parameter and is now the required second parameter after conversationId
.sendMessage()
: message
has been removed from the options
parameter and is now the required second parameter after conversationId
.(November 29, 2023)
wix-reviews.v2
The new Reviews API allows you to manage reviews for a site's services, content, or products. Functionality includes:
Note: This module is in Developer Preview.
(November 28, 2023)
Wix Editor Elements ($w)
The new TextMask API allows you to mask images and videos in the background of your text. Use the text
property to set or get the TextMask's plain-text content. Use the background.src
property to set or get the source of the TextMask's background.
(November 27, 2023)
Wix Editor Elements ($w)
The new SlideshowButton API allows you to customize the navigation buttons on your slideshow. Similar to the Button element, you can manage the labels, styles, icons, and visibility settings of a slideshow button. Note that you can't set a link to a slideshow button.
(October 17, 2023)
In the past few weeks, we've re-released some more legacy APIs. This follows the May, June, July, and August 2023 re-releases of legacy APIs.
You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.
Behind the scenes, this is part of a large, cross-Wix effort to move all of our APIs to a new infrastructure. This migration will allow us to release APIs more quickly after they're developed, and to align with established design patterns across all of Wix's APIs. This means you can get your hands on better, more consistent APIs, faster than before.
All the new modules are released as a developer preview and, unless otherwise mentioned, are universal modules.
Most of the APIs contain the same functionality as the previous version. In some rare cases, a regression was unavoidable. This list outlines the modules (and their respective namespaces) that were released, as well as any new or removed functionality as compared to the previous release:
wix-business-tools.v2
:
SiteProperties
namespace inside the module.getSiteProperties()
This function replaces all functions in the GeneralInfo
namespace inside the wix-site-backend
module.updateBusinessContact()
updateBusinessProfile()
updateBusinessSchedule()
updateConsentPolicy()
wix-members.v2
:
CurrentMember
namespace are now in the Members
namespace.createMember()
listMembers()
queryMembers()
getCurrentMember()
replaces getMember()
from CurrentMember
.joinCommunity()
replaces makeProfilePublic()
from CurrentMember
.leaveCommunity()
replaces makeProfilePrivate()
from CurrentMember
.updateCurrentMemberSlug()
replaces updateSlug()
from CurrentMember
.getRoles()
from CurrentMember
is not available.(October 15, 2023)
We added the following new $w Product Page APIs:
getCustomText()
: Gets the values of a product's custom text fields.getQuantity()
: Gets the quantity of a product in the Product Page.getSelectedChoices()
: Gets the selected product option choices of a product in the Product Page.getSelectedVariantId()
: Gets the variant ID of the selected product variant.onAddToCart()
: Adds an event handler that runs when the Add To Cart button in the Product Page is clicked.onBuyNow()
: Adds an event handler that runs when the Buy Now button in the Product Page is clicked.onChoiceSelected()
: Adds an event handler that runs when a product option choice is selected.onQuantityChanged()
: Adds an event handler that runs when a product's quantity is changed.setAddToCartLabel()
: Sets the Add To Cart button's label.setBuyNowLabel()
: Sets the Buy Now button's label.setQuantity()
: Sets the quantity of a product in the Product Page.We also added a tutorial that uses some of the new $w Product Page APIs: Tutorial: Adding a Request A Quote Option to a Wix Store Product Page.
(October 10, 2023)
The new Recommendations API allows you to promote and recommend items to your customers using recommendation algorithms. It includes the following endpoints:
Note: This module is in Developer Preview.
(September 21, 2023)
The new Back In Stock Notifications API allows you to manage customer requests to receive back in stock notifications when out-of-stock items become available.
Functionality includes:
Note: This module is in Developer Preview.
(September 4, 2023)
We've re-released another legacy API. This follows the May, June, and July 2023 re-releases of legacy APIs.
This API is released as a developer preview and is a universal module.
You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.
wix-bookings.v1
:
updateSchedules()
replaces updateResourceSchedule()
.queryResourceCatalog()
is not available.(August 31, 2023)
wix-pricing-plans.v2
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)
This API is only available for Wix Studio sites. Wix Studio is currently in beta and is not yet available to all users.
wix-web-module
The Web Modules API allows you to define functions in your backend code that can be called from your site's frontend code. Use the webMethod()
function to define a backend function and the permissions needed to call it.
(August 23, 2023)
The new Form Submissions API allows you to manage form submissions from your site visitors.
Functionality includes:
(August 21, 2023)
Wix Editor Elements ($w)
You can now add these elements to dashboard pages in your Wix site or in Wix Blocks:
(August 13, 2023)
Wix Editor Elements ($w)
Note: This feature is currently only available in Wix Studio and Editor X.
The new Accordion API allows you to display multiple, collapsible item elements in a vertical stack, each with different content.
(August 9, 2023)
The new Comments API allows you to manage a customized commenting program.
Functionality includes:
Note: This module is in Developer Preview.
(August 9, 2023)
The new eCommerce Validations SPI is a custom extension that allows you to validate a site visitor's cart and checkout.
The GetValidationViolations()
function validates a site visitor's cart or checkout and returns any validation violations. Site visitors can see the validation violations in their cart and checkout pages.
(July 30, 2023)
We've re-released another legacy API. This follows the May and June 2023 re-releases of legacy APIs.
This API is released as a developer preview and is a universal module.
You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.
wix-notifications.v2
:
notify()
has moved to the Notifications
namespace within the module.(July 24, 2023)
Wix Editor Elements ($w)
The new Effects API allows you to programmatically change the way supported elements are displayed on your site.
(July 19, 2023)
Wix Editor Elements ($w)
Note: This feature is currently in Beta and open to a limited number of users. You can now add CSS styling to customize the appearance of your website, from colors and fonts to the sizes and positions of different elements. Apply CSS to available global classes or create your own with the Custom Class List element.
(July 19, 2023)
Note: Wix Blocks is currently in Beta and open to a limited number of users.
This module includes functions to manage and get information about Blocks applications that are installed on a site.
It includes:
getDecodedAppInstance()
: Gets an installed Blocks app's instance, including its current pricing plan.getAppPageUrl()
: Gets the page URL of a Blocks app that was installed as a new page.openAppLightbox()
: Opens the lightbox of a Blocks app that was installed as a lightbox.(July 18, 2023)
We've migrated the frontend modules of legacy APIs
so they now end with -frontend
(for example, wix-bookings-frontend
replaces wix-bookings
).
Other than the name, these modules are identical to the modules they replace.
You don't need to take any action at this time. As always, we'll continue to support the legacy APIs so your existing code will continue to work as it does today. The legacy APIs will be hidden in the docs, so please refer to the new modules for reference.
What's in the release:
wix-animations-frontend
replaces wix-animations
.wix-bookings-frontend
replaces wix-bookings
.wix-crm-frontend
replaces wix-crm
.wix-events-frontend
replaces wix-events
.wix-location-frontend
replaces wix-location
.wix-members-frontend
replaces wix-members
.wix-pay-frontend
replaces wix-pay
.wix-pricing-plans-frontend
replaces wix-pricing-plans
.wix-realtime-frontend
replaces wix-frontend
.wix-seo-frontend
replaces wix-seo
.wix-site-frontend
replaces wix-site
.wix-storage-frontend
replaces wix-storage
.wix-stores-frontend
replaces wix-stores
.wix-window-frontend
replaces wix-window
.(June 21, 2023)
In the past few weeks, we've re-released some more legacy APIs. This follows the May 2023 re-release of the first batch of APIs.
You don't need to take any action at this time. As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.
Behind the scenes, this is part of a large, cross-Wix effort to move all of our APIs to a new infrastructure. This migration will allow us to release APIs more quickly after they're developed, and to align with established design patterns across all of Wix's APIs. This means you can get your hands on better, more consistent APIs, faster than before.
All the new modules are released as a developer preview and, unless otherwise mentioned, are universal modules.
Most of the APIs contain the same functionality as the previous version. In some rare cases, a regression was unavoidable. This list outlines the modules (and their respective namespaces) that were released, as well as any new or removed functionality as compared to the previous release:
wix-secrets.v2
:
Secrets
namespace inside the module.wix-workflows.v2
:
Workflows
namespace has been split into Workflows
, Tasks
, and Cards
.
Functions are now located in their respective namespaces.updateWorkflow()
replaces updateWorkflowFields()
.listWorkflows()
replaces listWorkflowsInfo()
.getWorkflow()
replaces getWorkflowInfo()
.updatePhase()
replaces updatePhaseFields()
.listPhases()
replaces listPhasesInfo()
.getPhase()
replaces getPhaseInfo()
.updateCard()
replaces updateCardFields()
.wix-groups.v2
:
approveGroupRequests()
replaces approveCreateRequests()
.listGroupRequests()
replaces listCreateRequests()
.queryGroupRequests()
replaces queryCreateRequests()
.rejectGroupRequests()
replaces rejectCreateRequests()
.wix-crm.v2
:
Contacts
namespace is split into Contacts
, Labels
, and ExtendedFields
.updateTaskStatus()
replaces completeTask()
and resetTask()
.wix-captcha.v2
:
authorize()
has moved to the Captcha
namespace within the module.(June 20, 2023)
wix-dashboard
The new Wix Dashboard API allows you to interact with your site's dashboard pages using Velo. You can use the API to navigate users to dashboard pages, and display toast messages.
(June 13, 2023)
wix-events.v2
The new Guests API provides the ability to retrieve information about guests attending an event by using the queryGuests
method.
Note: This module is in Developer Preview.
(June 8, 2023)
wix-bookings.v2
The new Wix Bookings Attendance APIs provide the following functionality:
Note: This module is in Developer Preview.
(June 8, 2023)
wix-loyalty.v2
The new Wix Loyalty APIs provide the following functionality:
Note: This module is in Developer Preview.
(May 31, 2023)
wix-bookings.v2
You can now handle events for when bookings are created, rescheduled, confirmed, declined, canceled, and for when the number of participants has been updated.
(May 30, 2023)
wix-bookings.v2
The new Wix Bookings v2 Service Options and Variants APIs provide functionality for retrieving and managing booking service options and variants. Functionality includes:
Note: This module is in Developer Preview.
(May 22, 2023)
wix-data.v2
The new Wix Data API, combined with the existing wix-data
, provides a complete solution for accessing, organizing, configuring, and managing data stored in a Wix site's database. It includes the following submodules:
Note: This module is in Developer Preview. To access and manage items in a Wix site's data collections, please use the existing wix-data
.
(May 17, 2023)
fields()
function in Wix Data querywix-data
A new feature in WixDataQuery
provides more control over query results.
Previously queries returned all fields of the selected result. Now, you can choose which fields your query returns using the new fields()
function.
(May 17, 2023)
Wix Editor Elements ($w)
You can now delete and restore elements from the DOM.
A new deleted property has been added.
2 new functions have been added:
delete()
restore()
(May 17, 2023)
In the past week, we've re-released a large number of legacy APIs. Behind the scenes, this is part of a large, cross-Wix effort to move all of our APIs to a new infrastructure.
This migration will allow us to release APIs more quickly after they're developed, and to align with established design patterns across all of Wix's APIs. This means you can get your hands on better, more consistent APIs, faster than before.
As always, we'll continue to support the legacy APIs, so your existing code will continue to work as it does today.
All the new modules are released as a developer preview and, unless otherwise mentioned, are universal modules.
Most of the APIs contain the same functionality as the previous version. In some rare cases, a regression was unavoidable. This list outlines the modules (and their respective namespaces) that were released, as well as any new or removed functionality as compared to the previous release:
wix-groups.v2
:
members.queryMemberships()
uses a different query syntax.wix-stores.v2
:
getInventoryVariants()
queryInventory()
This function uses a different query syntax.queryAbandonedCarts()
This function uses a different query syntax.wix.members.v2
:
getBadge()
getMemberCountsPerBadge()
listBadges()
updateBadgesDisplayOrder()
wix.ecom.v2
:
wix-ecom.v2
from wix-pay
.
listCurrencies()
replaces getAllCurrencies()
.wix-marketing.v2
:
bulkCreateCoupons()
bulkDeleteCoupons()
getCoupon()
queryCoupons()
This function uses a different query syntax.wix-pricing-plans.v2
wix-pricing-plans.v2
Plans from wix-pricing-plans-backend
.managementGetOrder()
replaces getOrder()
.
managementListOrders()
replaces listOrders()
.
memberGetOrder()
replaces getCurrentMemberOrder()
.
memberListOrders()
replaces listCurrentMemberOrders()
.
requestCancellation()
replaces requestCurrentMemberOrderCancellation()
createOfflineOrder()
moved to Orders from Checkout.
getOfflineOrderPreview()
moved to Orders and replaces previewOfflineOrder()
from Checkout.
getPricePreview()
moved to Orders and replaces previewPrice()
from Checkout.
onPlanPurchased()
is not available.onPlanUpdated()
is not available.(May 15, 2023)
SPI: wix-bookings
The new Wix Bookings Custom Pricing extension gives you the ability to customize pricing for bookings. Use the calculatePrice()
SPI function to integrate your own custom pricing logic, such as varied pricing for weekend rates or use of special equipment, and so on. Learn more with this tutorial.
(May 17, 2023)
wix-ecom.v2
The new Wix Currencies API provides functionality for getting exchange rates and converting between currencies.
This API is a newer version of Wix Pay's Currencies API.
Functionalities include:
Note: This module is in Developer Preview.
(May 5, 2023)
wix-bookings
The Shareable Booking Form Links article explains how to use query parameters to create a custom shareable link to a Wix site's booking form page. This enables you to create a link to a Wix site's booking form page with preset values determined by you. (April 30, 2023)
Note: Wix Blocks is currently a Beta version, open to a limited number of users.
The wix-widget
and wix-editor
modules provide functionality for working with Blocks widgets from the Blocks Panel code.
wix-widget
to control a widget's properties, Design Presets, and more.wix-editor
to remove or restore widget elements, open Dashboard panels, and more.(April 24, 2023)
Note: Wix Blocks is currently a Beta version, open to a limited number of users.
The $widget
namespace contains functionality for working with your Blocks widget's API from within the widget code.
(April 24, 2023)
Note: Wix Blocks is currently a Beta version, open to a limited number of users.
The following elements can be added to Blocks Custom Panels and managed in the Blocks Panel Code:
(April 24, 2023)
wix-bookings.v2
The new Wix Extended Bookings API provides functionality for querying bookings including additional details, such as attendance.
Note: This module is in Developer Preview.
(April 4, 2023)
wix-media.v2
The new Wix Media API introduces functionality for managing files and folders in your site's Media Manager.
Functionality includes:
Note: This module is in Developer Preview.
(April 3, 2023)
wix-bookings.v2
The new Wix Bookings Pricing API provides functionality for previewing and calculating pricing for bookings.
Functionality includes:
Note: These modules are in Developer Preview.
(April 2, 2023)
wix-paid-plans
, wix-paid-plans-backend
The deprecated wix-paid-plans
and wix-paid-plans-backend
APIs have been removed from the documentation. Their functionality is available in the wix-pricing-plans
and wix-pricing-plans-backend
APIs. Existing code containing these deprecated APIs will continue to work.
(March 27, 2023)
wix-users
, wix-users-backend
The deprecated wix-users
and wix-users-backend
APIs have been removed from the documentation. Their functionality is available as noted below. Additionally, getPricingPlans()
has moved to the Orders
API as listCurrentMemberOrders()
. Existing code containing these deprecated APIs will continue to work.
(March 27, 2023)
wix-bookings
The Shareable Booking Calendar Links article explains how to use query parameters to create a custom shareable link to a Wix site's booking calendar page. This enables you to create a link to a Wix site's booking calendar page with preset values you choose, or to create a link for rescheduling an existing booking. (Feb 12, 2023)
wix-email-marketing.v2
The new Wix Email Marketing API provides functionality for managing your email marketing campaigns.
Functionalities include:
Note: This module is in Developer Preview.
(February 5, 2023)
wix-ecom-backend
There are new APIs in the Wix eCommerce module.
The new APIs provide the following functionality:
(January 26, 2022)
We've made 2 big changes to the Velo platform:
Versions:
Versions are now available for Velo modules.
Modules from v2 and up include a version number in their names.
Older versions of the modules are still available.
Universal modules:
New universal modules can be imported directly into any code file on your site.
This means that you can import modules
into public and page code without using web modules.
Learn more about versions and universal modules.
(January 19, 2023)
Today we can announce that we've started releasing APIs with the new Developer Preview status!
Developer Preview APIs are available for testing, but they're under active development and may change at any time. For this reason, don't use Developer Preview APIs in production.
We want your feedback on the APIs in Developer Preview. Let us know about:
Please email us with your feedback.
For more information, see Developer Preview.
(January 19, 2023)
wix-sender-details.v2
The new Wix Sender Details API provides functionality for the information that's displayed as the sender's name and email address when sending an email from your Wix site.
Functionalities include:
Note: This module is in Developer Preview.
(January 25, 2023)
wix-loyalty.v2
The new Loyalty API provides functionality for:
Note: This module is in Developer Preview.
(January 25, 2023)
wix-events.v2
The new Wix Events v2 API provides functionality for:
Note: This module is in Developer Preview.
(January 25, 2023)
wix-bookings.v2
The new Wix Bookings API provides functionality for:
queryAvailability()
function.Note: This module is in Developer Preview.
(January 23, 2023)
wix-marketing-tags.v2
The new Wix Marketing Tags V2 API provides functionality for:
Note: This module is in Developer Preview.
(January 23, 2023)
wix-activity-counters.v2
The new Wix Activity Counters V2 API provides functionality for managing activity counters for site members.
Note: This module is in Developer Preview.
(January 23, 2023)
wix-inbox.v2
The new Wix Inbox API introduces functionality for managing conversations and messages between you and your visitors, contacts, and members.
Note: This module is in Developer Preview.
(January 23, 2023)
wix-forum.v2
Use the new Forum API to get and query the following from your forum:
Note: This module is in Developer Preview.
(January 22, 2023)
wix-business-tools.v2
The new Wix Business Tools API provides functionality for managing a site’s business information. Currently it contains the Locations submodule, for managing a site’s business locations.
Note: This module is in Developer Preview.
(January 19, 2023)
wix-auth
The new Wix Auth API provides functionality for working with permissions. The elevate()
function enables any site visitor to call a function without the required permissions. Note: This function replaces the suppressAuth
option used in some functions. Check a function's reference documentation to see if elevate()
is supported.
(January 16, 2023)
wix-pro-gallery-backend
Use the new Pro Gallery Backend API to create and manage pro galleries on your site's backend. You can also create and manage media items in the pro galleries.
(January 11, 2023)
wix-dataset
You can now use the new promise-based onReadyAsync()
function to load a dataset.
(January 10, 2023)
wix-blog-backend
Use the new Blog API to get, list, and query the following from your blog:
(December 22, 2022)
wix-marketing-backend
The new discountCycleCount
parameter allows you to apply the discount of a coupon, created with the createCoupon()
function, to a specified amount of billing cycles.
(November 7, 2022)
Wix Editor Elements ($w)
The new Menu API and MenuContainer API allow you to customize your menu items by changing their labels, links, where the item opens, and if an item displays as selected. This includes using Velo to modify site menus in real time during the visitor's stay on your site.
Use the Menu API for the menu on your regular site and use the MenuContainer API for your mobile menu.
(October 19, 2022)
wix-data
The new consistentRead
property in the options
parameter allows data retrieval functions to read from the primary database instance. This decreases performance but ensures data retrieved is up to date even immediately after the database is updated. See Wix Data and Eventual Consistency for more information.
(October 2, 2022)
Wix Editor Elements ($w)
The new Section API allows you to divide your page into meaningful segments. (September 28, 2022)
Wix Editor Elements ($w)
The Wix Events element allows you to display your site's events. The element can be set to display a specific set of events or all the events in an event category. Use the categoryId
property to dynamically change which event category to display. (September 20, 2022)
wix-pricing-plans-backend
The new applyCoupon()
function applies a coupon code to a draft order before it is purchased.
(September 20, 2022)
Wix Editor Elements ($w)
The new Tabs Component allows users to display different content within one page without changing the URL and without the need to use code. With the Tabs API, you can reorder tabs or navigate between them using code. You can also define event handlers that run when tabs are navigated between or tab menu items are clicked. (September 20, 2022)
wix-members
, wix-members-backend
The wix-members
and wix-members-backend
documentation
has been updated to reflect that the member contactDetails.customField
object
contains key:object pairs,
not key:value pairs as was previously written.
We also wrote additional guidance on working with custom fields.
(September 19, 2022)
wix-pricing-plans
, wix-pricing-plans-backend
There are new APIs for managing pricing plan orders. The additions include order management functions both on the frontend and the backend, and more backend events.
The newly supported activities include:
Please note the deprecation and migration instructions we added to the Paid Plans documentation. (August 28, 2022)
wix-data
The Wix Data Error Codes article lists all the error codes you might encounter while using the Wix Data API. The article explains what causes the errors and what you can do to resolve them. (July 27, 2022)
Wix Editor Elements ($w)
With the new Lottie API, you can now add a Lottie element to your site and customize it. You can play()
, pause()
, and stop()
your animation. You can also set the speed
of your Lottie animation and whether it plays in a loop
.
(June 22, 2022)
wix-members
You can now check whether the current site visitor is a logged-in member
by calling the new wix-members
loggedIn()
function.
This allows you to quickly confirm a member is logged in
before calling another function that requires a logged-in member.
(June 21, 2022)
wix-search
You can now use the searchFields()
function to refine a WixSearchBuilder
to search only in specified collection fields. (May 30, 2022)
wix-configs-backend
When building a Velo package in Wix Blocks, you can use the getPackageConfig()
function in your backend code to retrieve data from the package's config.json
file. (April 14, 2022)
Wix Editor Elements ($w)
You can now use the onViewChange()
function to add an event handler that triggers when the date picker's view changes. (April 10, 2022)
wix-members
You can now use the sendSetPasswordEmail()
function from the frontend code to send a site member an email with a link to set, or reset, their password. (April 1, 2022)
Wix Editor Elements ($w)
You can now set/get, expand, and collapse a button's icon in your code. The iconCollapsed
property allows you to check if an icon is currently collapsed. (March 29, 2022)
Wix Editor Elements ($w)
You can now show and hide the number spinner on a textInput element when the element is for numeric input.
A new numberSpinnerHidden
property has been added.
2 new functions have been added:
hideNumberSpinner()
showNumberSpinner()
(March 23, 2022)
wix-crm-backend
You can now handle events when one or more source contacts are merged into a target contact.
A new originatedFrom
property has also been introduced to the existing
onContactUpdated()
and onContactDeleted()
events.
When an update or delete event is triggered by a merge,
metadata.originatedFrom
is sent as "merge"
,
allowing you to ignore redundant events.
(February 3, 2022)
wix-media-backend
You can now use the Media Manager API to move files and folders to the Media Manager's trash bin.
(January 12, 2022)
Wix Editor Elements ($w)
You can now use the Date Picker API to set date ranges. Use the enabledDateRanges
property to set which dates a user can select. Use the disabledDateRanges
property to set which dates users can't select.
(January 12, 2022)
Wix Editor Elements ($w)
You can now set the enabled times for a time slot using the enabledTimes
property of the Time Picker API.
(December 29, 2021)