Release Notes

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.

Was this helpful, yes/no buttons

New property and methods: $w Button

Button ($w)

The Button element now includes a new property and 2 new methods, which are only available in Wix Studio.

New property

New methods

(May 4, 2025)

New events: Data

The Data Events module includes the following new events:

(April 14, 2025)

New API: Storage Mobile

wix-storage-mobile

Native mobile apps now have access to two types of storage through the Storage Mobile API.

Local: Data in local storage is saved to the device and remains accessible indefinitely as long as the app's storage is not cleared. The data can still be retrieved after closing and reopening the app.

Memory: Data in memory storage is available as long the user or operating system doesn't close the app. Closing the app clears the memory storage data.

(April 7, 2025)

New property: accessibility for [$w Element]

Wix Editor Elements ($w)

The accessibility object allows you to set various accessibility properties, including ARIA attributes. The following elements now include the accessibility object:

Note that not all elements support the same accessibility properties. Refer to an element's accessibility object to see which accessibility properties are supported by that element.

(April 3, 2025)

New property: lang for $w Element accessibility

Wix Editor Elements ($w)

The lang property enhances accessibility by allowing assistive technologies to recognize the language of the content, improving navigation and comprehension for users.

The following elements have been updated to now support the lang property within their accessibility object:

The following elements now support a limited version of the accessibility object, which includes only the lang property:

(March 27, 2025)

New property: accessibility for $w.menu

Menu ($w)

The menu element now includes a new accessibility object, which allows you to set various accessibility properties, including ARIA attributes, for the menu element. Supported properties include:

  • ariaDescribedBy
  • ariaLabel
  • ariaLabelledBy
  • ariaLive
  • lang
  • role
  • screenReader

(March 25, 2025)

New properties: $w Pagination

The pagination element has the following new properties:

(March 24, 2025)

New API: App Framework

wix-mobile

The new App Framework API contains functionality for working with a mobile app.

The App Framework API includes these new methods:

  • showActionSheet(): Displays an action sheet to the app user.
  • showFileUploadPicker(): Allows app users to select files or capture media from their camera to upload to the application.
  • showInAppNotification(): Use in-app notifications to provide real-time updates and alerts without interrupting the app user's experience.
  • showToastNotification(): Use toast notifications to provide app users with brief messages without interrupting the workflow.

Also, note that showAlert() was moved to the App Framework API.

(March 23, 2025)

New method: wix-stores-frontend

wix-stores-frontend.Navigate has a new method, toProduct().

(March 23, 2025)

New methods: wix-navigate-mobile

wix-navigate-mobile has 3 new methods:

(March 23, 2025)

New APIs: $w

$w now has 2 new elements.

  • Mobile Date Picker: A mobile date picker is used for entering dates. It lets app users populate a date field by picking a date using a calendar popup.
  • Mobile Video Player: A mobile video player allows you to present video on a mobile app.

(March 20, 2025)

New API: $w SearchButton

SearchButton ($w)

The Search Button element opens the site search interface from any page on a site. The API supports the same properties as the regular Button API, except for links.

(March 18, 2025)

New properties: $w.multiStateBox

MultiStateBox ($w)

The multi-state box element includes the following new properties to enhance accessibility for your site:

  • accessibility: Allows you to set ARIA attributes for the multi-state box, improving the experience for visitors who rely on assistive technologies. Supported attributes include:
    • ariaCurrent
    • ariaDescribedBy
    • ariaHidden
    • ariaLabel
    • ariaLabelledBy
    • role
  • tabIndex: Enables you to manage the keyboard tab navigation order for the multi-state box, ensuring that visitors using keyboard navigation can interact with your site efficiently.

(March 18, 2025)

New article: Migrate to the SDK

The Migrate from wix-data to the Data Items SDK article lists the changes between the Velo wix-data API and the Data Items SDK API.

Learn more about Velo APIs and the SDK.

(March 11, 2025)

New event handler: $w.MobileSwitch

$w.MobileSwitch now has an onChange event handler.

(March 3, 2025)

New feature: Develop websites with the Wix JavaScript SDK

You can now develop websites and create Blocks apps with the Wix JavaScript SDK. Learn more about the transition from Velo to the SDK.

(February 19, 2025)

Updated API: $w Menu

Menu ($w)

We are in the process of replacing Horizontal and Vertical menu types with a new general Menu type, which has horizontal and vertical layout options. The old and new menu types function similarly and are added by the same Horizontal and Vertical menu options in the editor's add panel.

There are some minor differences between the menu types:

  • The types have different CSS classes.
  • When you add a new item from the manage panel to the structure mega of a new Menu, the editor automatically adds a DropdownMenu component with the sub-menu and sub-sub-menu data. This component is not the same as the deprecated dropdownMenu menu type.

(Jan 27, 2025)

Updated API: Members Authentication

wix-members-frontend

The Members Frontend Authentication API now includes the following new functions:

  • sendResetPasswordEmail: Sends a site member an email with a link to set their password. Replaces sendSetPasswordEmail.
  • changePassword: Changes the member's password to a new one, using a reset token.
  • resendVerificationCodeEmail: Resends a one-time password (OTP) for email verification.
  • verifyEmail: Validates the email address using OTP (One-Time Password) that was sent during the registration.

(December 10, 2024)

New Service Plugin: Ecom Recommendations

The new Ecom Recommendations service plugin provides functionality for integrating advanced recommendation algorithms into your Wix site. This allows you to offer personalized product suggestions, enhancing user engagement and overall shopping experience.

(December 3, 2024)

Updated APIs: New rel property

Wix Editor Elements ($w)

The new rel property defines the relationship between a link's source page and the target page. Use rel to provide context to search engines and browsers about how to treat the link to influence SEO, security, and transparency with search engine guidelines.

The following elements now include the rel property:

(November 27 2024)

Updated APIs: New Styling Capabilities

Wix Editor Elements ($w)

Button

The Button element's style property now includes the ability to:

  • Change a button's icon color using the new iconColor style.
  • Modify the background color, border color, text color, and icon color of a button in its hover and disabled states using the new hover and disabled style objects.

Section

The Section element now includes the style property, allowing you to change a section's background color using the backgroundColor style.

Text

The Text element now includes the style property, allowing you to change a text's color in its regular state using the color style.

(November 26, 2024)

New API: Availability Exceptions

wix-restaurants.v2

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.

(November 21, 2024)

New API: Menu Ordering Settings

wix-restaurants.v2

The Menu Ordering Settings API allows you to retrieve and manage menu ordering settings for a restaurant operation.

(November 21, 2024)

Updated API: Radio Button Group

$w.RadioButtonGroup

The Radio Button Group element now includes a new function:

(November 18, 2024)

Updated API: Routers

wix-router

The ok() function has a new cache object in the options parameter that allows you to cache the function's return values. 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 router caching.

(November 4, 2024)

Updated API: Web Modules

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 backend function caching.

(November 4, 2024)

Reinstated Developer Preview API: Cache

wix-cache-backend

The Cache API allows you to invalidate your function's return value caches that were previously cached with the webMethod() function in wix-web-module or with the ok() function in wix-routers.

Use the invalidateCache() to specify which cached values to invalidate.

(November 4, 2024)

New Function: Analytics Session API

You can now mark recordings as deleted.

(October 28, 2024)

Fully Released: Marketing Consent API

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)

New Features: Accessibility and Tab Index

Wix Editor Elements ($w)

You can now make your Wix site more accessible to users with disabilities using the accessibility and tabIndex properties. The following APIs now support accessibility and tabIndex:

The accessibility property allows you to define specific ARIA (Accessible Rich Internet Applications) attributes for your elements, making your site more user-friendly for those relying on assistive technologies such as screen readers, braille displays, and voice control software. Note that the supported ARIA attributes vary based on the element being used.

The tabIndex property determines the order in which elements can be focused on using the tab key on the keyboard. This allows you to ensure that visitors using keyboard navigation can interact with your site efficiently.

Learn more about ARIA attributes and the importance of web accessibility.

(September 18, 2024)

Updated API: Time Slots API

wix-table-reservations.v2

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.

Removed API: Plans API

wix-pricing-plans.v2

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

(September 12, 2024)

Updated API: Reservations API

wix-table-reservations.v2

The Reservations API now includes a new function:

(September 4, 2024)

New APIs: Wix Restaurants

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:

Operations

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:

Service Fees

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:

Fulfillment Methods

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:

Menus

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

(August 27, 2024)

New API: Analytics Data API

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)

New API: Marketing Consent API

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)

New API: Analytics Sessions API

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)

New API: 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)

New API: Machine Translation API

wix-multilingual.v2

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)

Temporarily Removed: Web Method Cache

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)

New API: Tags

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)

Updated API: Wix Dashboard

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)

New API: Dashboard Favorite List API

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:

  • 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 Developer Preview API: Cache

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() to specify which cached values to invalidate.

Learn more about invalidating your function caches.

(June 16, 2024)

Updated API: Web Modules

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)

New APIs: Gallery

Wix Editor Elements ($w)

We added the following Gallery APIs:

(June 10, 2024)

New Functions: Loyalty Accounts API

wix-loyalty.v2

The Accounts API now includes two new functions:

(June 5, 2024)

New Functions: Loyalty Program API

wix-loyalty.v2

The Program API now includes three new functions:

(June 5, 2024)

New Functions: Loyalty Tiers API

wix-loyalty.v2

The Tiers API now includes two new functions:

(June 5, 2024)

New Functions: Loyalty Rewards API

wix-loyalty.v2

The Rewards API now includes two new functions:

(June 5, 2024)

New Release: Loyalty Transactions API

wix-loyalty.v2

The Loyalty Transactions API allows you to query transactions related to account activity. The new API includes:

(June 5, 2024)

Fully Released: Wix Loyalty APIs

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.

Loyalty Accounts APIs

Loyalty Programs APIs

Loyalty Tiers APIs

Loyalty Rewards APIs

(June 5, 2024)

New API: Ticket Definitions v2

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)

New API: WixComments Element

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)

New API: Dashboard 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)

Updated API: PanelButton Element

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)

New APIs: Forum Categories

wix-forum.v2

The Forum categories API has two new functions:

(April 22, 2024)

Updated API: MenuContainer Element

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)

Updated API: Wix Billing Backend

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)

Updated API: Container Element

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)

New API: Open Media Manager

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)

New APIs: Open and Close Modal

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)

New Developer Preview APIs: Wix URLs APIs

wix-urls.v2

Wix URLs introduces new APIs that provide developers with access to a site's URLs:

  • Wix Editor: Access the site's editor URL and site preview URL.
  • Wix Site: Access the site's published site URLs, included translated pages.

(April 14, 2024)

New release: More Wix Events APIs

wix-events.v2

Wix Events introduces new APIs that provide developers with a growing set of services for customizing Events functionality on Wix sites:

  • Categories: Create and assign various categories to their events.
  • Forms: Customize a registration form for site visitors to fill out with their contact details and other relevant information.
  • Orders: The Checkout module is now merged with Orders.
  • RSVP: Access the information on guests who have RSVP'ed to an event.
  • Schedule: Share the lineup of an event’s activities, presentations, performances, or sessions.
  • Schedule Bookmarks: Allow members to mark their favorite schedule items to curate their own personalized agenda for your event.
  • Wix Events v2: The updated Wix Events API where you can create and manage events on your site.

(April 4, 2024)

New Developer Preview APIs: Mobile Elements

Wix Editor Elements ($w)

Important:

  • These APIs are only relevant for custom widgets in Branded Apps.
  • Custom widgets are not yet available to all users.
  • These APIs are in Developer Preview and are subject to change.

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)

New Developer Preview API: Wix Mobile

wix-mobile

Important:

  • This API is only relevant for custom widgets in Branded Apps.
  • Custom widgets are not yet available to all users.
  • This API is in Developer Preview and is subject to change.

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)

New Developer Preview API: Wix Navigate Mobile

wix-navigate-mobile

Important:

  • This API is only relevant for custom widgets in Branded Apps.
  • Custom widgets are not yet available to all users.
  • This API is in Developer Preview and is subject to change.

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)

Updated API: Wix Window Frontend

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)

New: Wix Blocks Panel Builder Elements

The following elements can be added to Wix Blocks Custom Panels and managed in the Wix Blocks Panel Code:

  • PanelColorPicker The panel color picker is used in the Wix Blocks panel builder for picking colors from a color palette.
  • PanelFontAndColorPicker The panel font and color picker is used in the Wix Blocks panel builder for picking fonts from a dropdown and colors from a color palette.

(March 5, 2024)

New SPI: Velo Action

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)

Updated API: Tasks V2

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)

New APIs: Dashboard

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)

New API: WixFormsV2 Element

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)

Deprecated: Workflows API

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)

Updated API: Pricing Plans v2

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:

  • Orders:

    • 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)

New Release: More eCommerce APIs

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)

New API: Checkout Templates

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)

New APIs: Wix Bookings V2 Services Functions and Events

wix-bookings.v2

We added new APIs in the Wix Bookings Services V2 module that:

(January 29, 2024)

New API: Rich Content Viewer Element

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)

New Developer Preview API: Wix Blog Draft Posts

wix-blog-backend

The new Draft Posts 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.

Note: This module is in Developer Preview.

(December 31, 2023)

Temporarily Removed: Tasks API

wix-crm.v2

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

(December 25, 2023)

Removed: Workflows API

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)

New APIs: Hamburger Menu Element

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)

New Function: Media API

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)

Updated APIs: Pricing Plans Frontend and Pricing Plans Backend

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.

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)

Updated API: Wix Inbox v2

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)

New Developer Preview API: Reviews

wix-reviews.v2

The new Reviews API allows you to manage reviews for a site's services, content, or products. Functionality includes:

  • Create, delete, get, or update a review.
  • Query reviews.

Note: This module is in Developer Preview.

(November 28, 2023)

New API: TextMask

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)

New API: Slideshow Button

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)

Migration of legacy APIs, batch 3

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.

What's in this release

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:

  • All functions are now in the SiteProperties namespace inside the module.
  • Site Properties:
    • New: getSiteProperties() This function replaces all functions in the GeneralInfo namespace inside the wix-site-backendmodule.
    • New: updateBusinessContact()
    • New: updateBusinessProfile()
    • New: updateBusinessSchedule()
    • New: updateConsentPolicy()

wix-members.v2:

  • Functions from the previous CurrentMember namespace are now in the Members namespace.
  • Members:
    • 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)

New $w Product Page APIs

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)

New Developer Preview API: Recommendations

The new Recommendations API allows you to promote and recommend items to your customers using recommendation algorithms. It includes the following endpoints:

  • List available recommendation algorithms.
  • Get a list of item recommendations from an algorithm.

Note: This module is in Developer Preview.

(September 21, 2023)

New Developer Preview API: Back In Stock Notifications

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:

  • Settings that allow you to start and stop collecting requests.
  • Creating or deleting a back in stock notification request.
  • Getting or querying back in stock notification requests.
  • Manually reporting an item as back in stock, which triggers the requested notification to send.
  • Events when a back in stock notification request is created, updated, or deleted.

Note: This module is in Developer Preview.

(September 4, 2023)

Migration of Booking Resources API

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:

  • Resources:
    • updateSchedules() replaces updateResourceSchedule().
    • queryResourceCatalog() is not available.

(August 31, 2023)

Update: New fields in Pricing Plans

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)

New API: Web Modules

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)

New API: Forms Submissions

The new Form Submissions API allows you to manage form submissions from your site visitors.

Functionality includes:

  • Creating, updating, or deleting a submission.
  • Getting a submission or querying submissions by namespace.
  • Counting the number of submissions for a specific form.
  • Marking submissions as seen.
  • Confirming a submission has been recorded.
  • Getting a media upload URL to use when creating a submission with a field for uploading files.

(August 21, 2023)

New: Dashboard Builder Elements

Wix Editor Elements ($w)

You can now add these elements to dashboard pages in your Wix site or in Wix Blocks:

  • DashboardButton
  • DashboardHeading
  • DashboardIconButton
  • DashboardInfoIcon
  • DashboardInput
  • DashboardNumberInput
  • DashboardText
  • DashboardTextButton
  • DashboardToggleSwitch

(August 13, 2023)

New API: Accordion

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)

New Developer Preview API: Wix Comments v2

The new Comments API allows you to manage a customized commenting program.

Functionality includes:

  • Creating, updating, or deleting a comment.
  • Getting or querying comments.
  • Marking and unmarking a comment.
  • Counting comments.
  • Events when a comment is created, updated, deleted, marked, or unmarked.

Note: This module is in Developer Preview.

(August 9, 2023)

New SPI: eCommerce Validations

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)

Migration of Notifications API

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)

New API: Effects

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)

CSS Styling and Custom Class List

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 customClassList.

(July 19, 2023)

New Module for Wix Blocks: Wix Application

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)

Migration of frontend-only APIs

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)

Migration of legacy APIs, batch 2

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.

What's in this release

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:

  • All functions are now in the Secrets namespace inside the module.

wix-workflows.v2:

  • The Workflows namespace has been split into Workflows, Tasks, and Cards. Functions are now located in their respective namespaces.
  • Workflows:
    • updateWorkflow() replaces updateWorkflowFields().
    • listWorkflows() replaces listWorkflowsInfo().
    • getWorkflow() replaces getWorkflowInfo().
  • Phases:
    • updatePhase() replaces updatePhaseFields().
    • listPhases() replaces listPhasesInfo().
    • getPhase() replaces getPhaseInfo().
  • Cards:
    • updateCard() replaces updateCardFields().

wix-groups.v2:

  • CreateRequests:
    • approveGroupRequests() replaces approveCreateRequests().
    • listGroupRequests() replaces listCreateRequests().
    • queryGroupRequests() replaces queryCreateRequests().
    • rejectGroupRequests() replaces rejectCreateRequests().

wix-crm.v2:

  • The previous Contacts namespace is split into Contacts, Labels, and ExtendedFields.
  • Tasks:
    • updateTaskStatus() replaces completeTask() and resetTask().

wix-captcha.v2:

  • authorize() has moved to the Captcha namespace within the module.

(June 20, 2023)

New API: Wix Dashboard

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)

New Developer Preview API: Guests

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)

New Developer Preview API: Wix Bookings Attendance

wix-bookings.v2

The new Wix Bookings Attendance APIs provide the following functionality:

  • Set the attendance for a booked session, such as whether the session was attended and by how many participants.
  • Get the attendance information for a booked session.
  • Query the attendance information for a booked sessions by booking or by session.

Note: This module is in Developer Preview.

(June 8, 2023)

New Developer Preview API: Wix Loyalty Tiers, Rewards, and Coupons

wix-loyalty.v2

The new Wix Loyalty APIs provide the following functionality:

  • Manage a loyalty tiers program, including creating new tiers and updating settings that apply to all of the tiers in the program.
  • Manage the loyalty rewards and loyalty coupons that loyalty points can be redeemed for.

Note: This module is in Developer Preview.

(May 31, 2023)

New Events for Wix Bookings v2

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)

New Developer Preview API: Wix Bookings v2 Service Options and Variants

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:

  • Getting service options and variants by ID and by service ID.
  • Querying service options and variants.
  • Creating and cloning service options and variants.
  • Updating and deleting service options and variants.
  • Backend events for create, update, and delete (CUD) operations.

Note: This module is in Developer Preview.

(May 22, 2023)

New Developer Preview API: Wix Data v2

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:

  • Data Collections: Create data collections and manage existing collections' structure.
  • Indexes: Create indexes for data collections, to make querying data faster.
  • External Database Connections: Connect an external database and manage it with Wix Data APIs.

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)

New Feature: fields() function in Wix Data query

wix-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)

New Feature: Delete/Restore elements from the DOM

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)

Migration of legacy APIs

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.

What's in this release

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:

  • JoinGroupRequests replaces JoinRequests.
  • Members:
    • members.queryMemberships() uses a different query syntax.
  • Roles is not available.
  • CreateRequests is not available.
  • Events: All events are new.

wix-stores.v2:

  • Inventory:
    • New: getInventoryVariants()
    • New: queryInventory() This function uses a different query syntax.
  • AbandonedCarts:
    • New: queryAbandonedCarts() This function uses a different query syntax.

wix.members.v2:

  • Badges:
    • New: getBadge()
    • New: getMemberCountsPerBadge()
    • New: listBadges()
    • New: updateBadgesDisplayOrder()
  • Events: All events are new.

wix.ecom.v2:

  • Currencies moved to wix-ecom.v2 from wix-pay.
    • listCurrencies() replaces getAllCurrencies().

wix-marketing.v2:

  • Coupons:
    • New: bulkCreateCoupons()
    • New: bulkDeleteCoupons()
    • New: getCoupon()
    • New: queryCoupons() This function uses a different query syntax.

wix-pricing-plans.v2

  • Plans:

    • All plan functions moved to wix-pricing-plans.v2 Plans from wix-pricing-plans-backend.

  • Orders:

    • 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.

  • Checkout is not available.

  • Events:

    • onPlanPurchased() is not available.
    • onPlanUpdated() is not available.

(May 15, 2023)

New Bookings Custom Pricing Extension

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)

New Developer Preview API: Wix Currencies v2

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:

  • Listing currencies supported on your site.
  • Getting the exchange rate between 2 currencies.
  • Converting amounts from 1 currency to another.

Note: This module is in Developer Preview.

(May 5, 2023)

New Article: Shareable Booking Form Links

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)

New Modules for Wix Blocks Panels

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.

  • Use wix-widget to control a widget's properties, Design Presets, and more.
  • Use wix-editor to remove or restore widget elements, open Dashboard panels, and more.

(April 24, 2023)

New: The $widget Namespace for Wix Blocks Widgets

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)

New: Blocks Panel Builder Elements

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:

  • PanelButton**
  • PanelCheckboxGroup**
  • PanelDropDown**
  • PanelRadioButtonGroup**
  • PanelRichText**
  • PanelSectionDivider**
  • PanelSlider**
  • PanelTextInput**
  • PanelThumbnails**
  • PanelToggleSwitch**

(April 24, 2023)

New Developer Preview API: Query Wix Extended Bookings

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)

New Developer Preview API: Wix Media v2

wix-media.v2

The new Wix Media API introduces functionality for managing files and folders in your site's Media Manager.

Functionality includes:

  • Importing, updating, and deleting media files
  • Getting and searching files
  • Generating file upload and download URLs
  • Creating, updating, and deleting folders in the Media Manager
  • Getting and searching folders

Note: This module is in Developer Preview.

(April 3, 2023)

New Developer Preview API: Wix Bookings Pricing

wix-bookings.v2

The new Wix Bookings Pricing API provides functionality for previewing and calculating pricing for bookings.

Functionality includes:

  • Previewing how much a booking will cost based on its line items.
  • Calculating how much a booking will cost based on either:
    • Standard pricing logic supplied with Wix Bookings.
    • Custom pricing logic you implement with the Pricing Integration REST Service Plugin.

Note: These modules are in Developer Preview.

(April 2, 2023)

End of Life: Wix Paid Plans and Wix Paid Plans Backend

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)

End of Life: Wix Users and Wix Users Backend

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)

New Article: Shareable Booking Calendar Links

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)

New Developer Preview API: Wix Email Marketing v2

wix-email-marketing.v2

The new Wix Email Marketing API provides functionality for managing your email marketing campaigns.

Functionalities include:

  • Getting your email marketing account details.
  • Getting a list of your email campaigns.
  • Pausing a scheduled campaign.
  • Sending a test email for preview purposes.
  • Getting a list of statistics for up to 100 selected campaigns.

Note: This module is in Developer Preview.

(February 5, 2023)

New APIs: Wix eCommerce Checkout

wix-ecom-backend

There are new APIs in the Wix eCommerce module.

The new APIs provide the following functionality:

  • Adding items to a checkout.
  • Marking a checkout as completed.
  • Removing the coupon from a checkout.
  • Removing the gift card from a checkout.
  • Removing line items from a checkout.

(January 26, 2022)

Platform update: Versions and universal modules

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)

Platform update: Developer Preview APIs

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:

  • What you're using the API for.
  • Anything blocking you from using the API.
  • Additions and features you would find useful.
  • Bugs you've found in the API.

Please contact us with your feedback.

For more information, see Developer Preview.

(January 19, 2023)

New Developer Preview API: Wix Sender Details v2

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:

  • Getting and updating your email sender details.
  • Verifying your sender email address.

Note: This module is in Developer Preview.

(January 25, 2023)

New Developer Preview API: Wix Loyalty v2

wix-loyalty.v2

The new Loyalty API provides functionality for:

  • Activating and managing a site’s loyalty program.
  • Creating new loyalty accounts.
  • Adjusting points in a loyalty account.

Note: This module is in Developer Preview.

(January 25, 2023)

New Developer Preview API: Wix Events v2

wix-events.v2

The new Wix Events v2 API provides functionality for:

  • Creating and managing events.
  • Creating the types of tickets available for an event using ticket definitions.
  • Creating ticket reservations using checkout.
  • Selling tickets.
  • Tracking orders.
  • Creating and managing policies.

Note: This module is in Developer Preview.

(January 25, 2023)

New Developer Preview API: Wix Bookings v2

wix-bookings.v2

The new Wix Bookings API provides functionality for:

  • Managing bookings, such as confirming, canceling, and rescheduling bookings.
  • Retrieving the availability of a calendar's slots for appointments and classes with the queryAvailability() function.

Note: This module is in Developer Preview.

(January 23, 2023)

New Developer Preview API: Wix Marketing Tags v2

wix-marketing-tags.v2

The new Wix Marketing Tags V2 API provides functionality for:

  • List marketing tags.
  • Create and update marketing tags.
  • Delete marketing tags.

Note: This module is in Developer Preview.

(January 23, 2023)

New Developer Preview API: Wix Activity Counters v2

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)

New Developer Preview API: Wix Inbox v2

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)

New Developer Preview API: Wix Forum v2

wix-forum.v2

Use the new Forum API to get and query the following from your forum:

  • Posts
  • Categories

Note: This module is in Developer Preview.

(January 22, 2023)

New Developer Preview API: Wix Business Tools v2

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)

New API: Wix Auth

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)

New API: Wix Pro Gallery Backend

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)

New API: Dataset onReadyAsync()

wix-dataset

You can now use the new promise-based onReadyAsync() function to load a dataset.

(January 10, 2023)

New API: Wix Blog

wix-blog-backend

Use the new Blog API to get, list, and query the following from your blog:

  • Posts
  • Categories
  • Tags

(December 22, 2022)

Update: Apply a coupon to specific billing cycles

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)

New APIs: Menu and MenuContainer

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)

Update: Wix Data consistentRead property

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)

New API: Section

Wix Editor Elements ($w)

The new Section API allows you to divide your page into meaningful segments. (September 28, 2022)

New API: Wix Events

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)

New API: Apply a coupon to a pricing plan order

wix-pricing-plans-backend

The new applyCoupon() function applies a coupon code to a draft order before it is purchased. (September 20, 2022)

New API: Tabs

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)

Updated: Members custom field structure

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)

New API: Pricing Plan Orders

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:

  • Creating and updating both online and offline orders.
  • Purchasing orders.
  • Canceling orders.
  • Getting and listing orders.
  • Postponing, pausing, and resuming orders.
  • Marking offline orders as paid.

Please note the deprecation and migration instructions we added to the Paid Plans documentation. (August 28, 2022)

New Article: Wix Data Error Codes

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)

New API: Lottie

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)

New API: Check whether a member is logged in

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)

New API: Refine search fields

wix-search

You can now use the searchFields() function to refine a WixSearchBuilder to search only in specified collection fields. (May 30, 2022)

New API: Retrieve package configuration data

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)

New API: Date Picker onViewChange()

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)

New API: sendSetPasswordEmail() from the frontend

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)

New API: Button Icon

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)

New Feature: Show/Hide number spinner on textInput elements

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)

New Event: Contact Merged

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)

New API: Delete files and folder from Media Manager

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)

New API: Date Picker API improvements

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)

New API: Set enabledTimes for Time Picker

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)

Update: Using forEachItem() with repeater data from a dataset

Wix Editor Elements ($w)

We noted that when using forEachItem() with repeater data populated by a dataset, you should call it within the dataset's onReady() function.

(December 28, 2021)

Update: Upload Button file types

Wix Editor Elements ($w)

The reference now lists the file types supported by the Upload Button element.

(December 20, 2021)

New API: Generate download URLs with the Media Manager

wix-media-backend

The Media Manager API now includes 2 new backend functions, downloadFiles() and downloadFolder(), that generate URLs for downloading Wix media.

(December 20, 2021)

Update: formFactor doesn't return Editor X breakpoint values

wix-window

The formFactor property only returns the type of a site visitor's device. This doesn't correspond to the site's Editor X breakpoint values. (December 14, 2021)

New API: Access the site from the frontend

wix-site

You can access a site's name in frontend code using the new getSiteDisplayName() function.

(December 9, 2021)

New API: Direct navigation to the cart page

wix-stores

The navigate.toCart() function directs a site visitor's browser directly to their cart page without needing to supply a URL path.

(December 7, 2021)

New API: Wix Groups

wix-groups-backend

Use the new Groups API to create and manage groups on your site. Here are some things you can do:

  • Create a group
  • Join a group
  • Add members to a group
  • Assign an admin role to a group member

(December 7, 2021)

New API: Open Quick View with code

wix-stores

Use the product.openQuickView() function to open a product's Quick View modal from directly within your code.

(November 30, 2021)

Update: Wix Storage items accept numbers

wix-storage

The value parameter of the setItem() function accepts numbers as well as strings.

(November 15, 2021)

New API: Wix Members and Wix Members Backend

wix-members , wix-members-backend

The wix-users and wix-users-backend APIs have been deprecated. Most of their functionality has moved to the new wix-members and wix-members-backend APIs. The emailContact() and emailUser() (now emailMember()) functions have moved to the respective TriggeredEmails APIs of wix-crm and wix-crm-backend. Functions that handle consent policy have moved to the ConsentPolicy API in wix-window. Finally, wix-members and wix-members-backend have several new functions:

  • changeLoginEmail() changes a site member's login email address.
  • sendSetPasswordEmail() sends a site member an email with a link to set their password.
  • makeProfilePrivate() removes a logged-in member from the site community and sets their profile to private.
  • makeProfilePublic() adds a logged-in member to the site community and sets their profile to public.
  • onLogout() sets the function that runs when a member logs out.

(November 2, 2021)

New API: Optional override parameter for onCustomValidation()

Wix Editor Elements ($w)

The onCustomValidation() function now has an override parameter which allows you write a series of custom element validations and set which ones will run.

(October 28, 2021)

Updated: Maximum size for collection items

wix-data

The maximum size for collection items when running insert() or update() is 500 KB, not 200 KB.

(October 17, 2021)

Updated: getUser() may return undefined for memberName

wix-users-backend

When a user is registered with an email address but no name the object returned by getUser() has a value of undefined for memberName.

(October 13, 2021)

New API: Product brand field

wix-stores-backend

The Product object in wix-stores-backend now accepts a value for brand. Including a brand name can help improve a site's (and product's) visibility in search results.

(October 12, 2021)

Updated: Dataset functions save draft data

wix-dataset

When using a read-write dataset, calling the following functions saves any changes made to linked input elements: setFilter(), setSort(), nextPage(), previousPage(), loadPage(), setPageSize(), setCurrentItemIndex(), next(), previous(), save()

(October 6, 2021)

Updated: Premium account required to use checkoutBooking()

wix-bookings

You need a premium account to checkout bookings of any type.

(October 5, 2021)

Updated: Using scrollTo() with header elements

Wix Editor Elements ($w)

You can only use scrollTo() with Header Elements when the Header Scroll Setting is set to Scrolls with site. To scroll to the header with other settings, use the wix-window scrollTo() function.

(October 5, 2021)

Updated: Realtime channel naming requirements

wix-realtime-backend

Channel names in Wix Realtime cannot include spaces or special characters.

(October 5, 2021)

Updated: Security best practices for createSecret(), updateSecret(), and listSecretInfo()

wix-secrets-backend

Make sure not to leave information about secrets in your code when running createSecret() or updateSecret()! Do not expose functions that call listSecretInfo() to frontend code without setting permissions to Admin! See the reference for more details.

(October 3, 2021)

Updated: WixHttpFunctionRequestBody is available as binary

wix-http-functions

The WixHttpFunctionRequestBody.buffer() function returns the body of the http request in binary as a Node.js Buffer object. (September 14, 2021)

Updated: Wix Realtime functions support both synchronous and asynchronous calls

wix-realtime-backend

You can call the WixRealtimeBackend functions publish() and realtime_check_permission() as well the PermissionsRouter functions add() and check() either synchronously or asynchronously. (August 17, 2021)

Updated: Coupon limits unsupported in Wix Bookings

wix-marketing-backend

You can't set the limitPerCustomer parameter when using coupons in Wix Bookings. (August 11, 2021)

Updated: Working with promptLogin() and promptForgotPassword()

wix-users

Resolve promises returned when calling the promptLogin() and promptForgotPassword() functions within the onReady() block using .then() and .catch(). If you await or return the results, the page will not load. (August 11, 2021)

Updated: SuppressAuth for WixDataAggregate

wix-data

WixData.aggregate.run() supports suppressAuth functionality. (August 10, 2021)

Updated: VideoBox src property is read & write

$w.VideoBox

You can both get and set the VideoBox src property. (August 10, 2021)

New API: Wix Events Backend

wix-events-backend

The new Wix Events Backend API provides functionality for creating, updating, deleting, canceling, and querying Wix events. For example, you can create RSVP and ticketed events whose locations and/or dates are "To Be Announced" (TBA), you can customize registration messages, and you can configure settings for online conferencing. (July 20, 2021)

Updated: Dataset new() function replaced by add() function

wix-dataset

The Dataset and Dynamic Dataset new() functions were replaced by the add() function. We replaced the function to avoid confusion with the JavaScript new operator. Functionality of the add() and new() functions is identical. (July 20, 2021)

New API: Media Manager list files & folders

wix-media-backend

The listFiles(), listFolders(), and getFolderInfo() functions allow you to get information about specific files and folders in the Media Manager. (July 6, 2021)

Updated: seoMarkup property is read & write

$w.CustomElement

You can both get and set the Custom Element seoMarkup property. (July 6, 2021)

Updated: Use application/json for HTTP function response content-type in free sites

wix-http-functions

text/html is not supported for the content-type header in an HTTP function response. Use application/json instead. Premium sites support all content types. (July 6, 2021)

Updated: listPlans() and listPublicPlans() return an array of objects

wix-pricing-plans-backend

The listPlans() and listPublicPlans() functions return an array of objects. (July 6, 2021)

Updated: Wix Location to() has a new option

wix-location

The disableScrollToTop option lets you decide if the page scrolls to the top when navigating to another Wix page. When true, the page remains at the same Y-axis position as the previously viewed page. (July 5, 2021)

Added Velo Package Readmes

By popular requests we've added the readme files for Velo Packages to the API Reference. This will allow you to keep the readme file open side by side with your code file.

Updated: Clarified path and prefix

wix-location

We updated the path graphics to show the correct path and included a statement that prefix is for dynamic pages only. (June 14, 2021)

New API: Multi-file upload

Wix Editor Elements ($w)

You can now upload multiple image, video, and gallery (images and video) files at a time. This function replaces the now deprecated startUpload function. (June 14, 2021)

Updated: Stores: Add "ribbon" field to product entity

wix-stores-backend

On the Product entity, the ribbons field, which took an array and was read-only, has been deprecated. The new field ribbon, which takes a string and is writable upon product creation, replaces it. (June 13, 2021)

Updated: Fixed Bookings hasNext example

wix-bookings

We fixed the import statement in the examples. (June 10, 2021)

Update: onBeforeSave returns a promise

wix-data

We fixed the description of onBeforeSave to say it returns a promise that resolves to a boolean not a boolean. (June 6, 2021)

New API: Manage Bookings resources and sessions

wix-bookings-backend

The bookings backend API now includes functionality to add, delete, manage, and query resources and sessions. (May 10, 2021)

New APIs: Stores showMinicart and hideMinicart

wix-stores

With the new cart.showMiniCart() and cart.hideMiniCart() APIs you can easily show and hide the Mini Cart from appearing on the page. (May 10, 2021)

New API: Stores updateLineItemQuantity

wix-stores With the new cart.updateLineItemQuantity() function you can set the quantity of a certain line item of the store cart. (May 10, 2021)

New API: Stores addProducts

wix-stores

With the new cart.addProducts() function you can add one or more products to the store cart by passing the productId, the desired quantity, and if necessary, any specific product options. (May 10, 2021)

Update: Stores: Migrate to wix-stores.cart/product

wix-stores

As part of a redesign of the Wix-Stores API, several new functions have been added and existing functions have been migrated to either the Cart or Product modules.

The API ref has been updated with migration instructions for users using the old functions.

Several new functions have been added as well: cart.addProducts(), cart.apply/removeCoupon(), cart.showMiniCart, cart.hideMiniCart(), and cart.updateLineItemQuantity().

(May 10, 2021)

New API: Stores apply & remove coupon

wix-stores

With the new cart.applyCoupon() and cart.removeCoupon() functions you can add a coupon to the store cart by passing the coupon code, or remove a previously applied coupon. (May 10, 2021)

Updated: Removed tip to use onInput with richTextBox

Wix Editor Elements ($w)

onInput is not supported for richTextBox. We removed a tip to use onInput to get the value of the latest keyboard event for a richTextBox. (May 5, 2021)

Updated: Effect options for show and hide are optional

Wix Editor Elements ($w)

We updated the show and hide functions to indicate that the effectOptions are optional. (May 5, 2021)

Updated: afterUpdate supports the currentItem property

wix-data

We added back information that the afterUpdate hook supports the currentItem property in the updateHookContext parameter. (May 5, 2021)

Updated: isReferenced supports the wixDataOptions parameter

wix-data

We added information that isReferenced supports the wixDataOptions parameter, which enables suppressAuth and suppressHooks. (May 5, 2021)

Updated: queryReferenced options parameter is listed as optional

wix-data

The options parameter of queryReferenced() was mistakenly listed as required. We fixed it to be optional. (May 5, 2021)

Updated: New env property added to WixRouterRequest object

wix-router

We added a new env property to WixRouterRequest.

When possible, the rendering process is split in two, to improve performance. The first cycle in the process is initiated from backend rendering, and the second cycle is initiated from client-side rendering. You can use the env property to check whether the current rendering cycle is occurring on the backend or the client side. (May 5, 2021)

Updated: Size property of File object for UploadButton is Number

Wix Editor Elements ($w)

We changed the type of the size property of the object that is returned by the value property from string to number. (May 5, 2021)

Updated: Pricing Plans setPlanVisibility returns a complete pricing plan

wix-pricing-plans-backend

The setPlanVisibility function now returns a complete pricing plan object when its visibility is set. (May 5, 2021)

New API: warmupData

wix-window

With the new warmupData API, you can optimize data loading for sites that render both in the backend code and in the client-side code, allowing costly data fetching operations to be done only once. (April 13, 2021)

Updated: insertReference() only works with multi-reference fields

wix-data

We added a note that insertReference() only works with multi-reference fields. (April 13, 2021)

Update: 512 KB limit for http functions

wix-http-functions

We added note that http function requests have a request payload limit of 512 KB. (April 12, 2021)

New API: Login as a popup option

wix-users

With the new modal option for the wix-users promptLogin() function, you can let visitors log in using a modal popup. (April 12, 2021)

New API: CRM Contacts

wix-crm-backend

We released new CRM Contacts APIs allowing you to:

  • Create, update, get, query, and delete contacts
  • Label/unlabel contacts
  • Manage labels
  • Manage custom fields

This replaces most of the existing Contacts functions, and those functions have been updated with migration instructions. Existing functions are supported so you don't need to migrate immediately. (April 12,2021)

Updated: Added the suppressAuth option to createInvoicePreviewUrl()

wix-billing-backend

We added suppressAuth options to createInvoicePreviewUrl() to allow customers to generate the invoice preview link. (April 12, 2021)

Updated: Added note that setFilter() on a read-write dataset saves changes in the input field

wix-dataset

When you call setFilter() on a dataset with a connected input field, any changes made in the input field are also saved. (April 11, 2021)

Update: Remove read-only fields from updateUserFields parameters

wix-users-backend

We removed the read-only fields from the list of parameters for updateUserFields(). (April 11, 2021)

New Wix Stores Variants Collection in the Content Manager and Velo Databases

wix-stores

Alongside Orders, Products, and other Stores collections, Variants are now available for access and query using Velo and the Content Manager.

Variants are combinations of product options, and until now they were only accessible per product. The new Variants collection includes all of a store's variants.

Learn more about the new Wix Stores Variants Collection. (April 1, 2021)

Updated: Added updatedItemsIds to WixDataBulkResult

We added the updatedItemIds property to the WixDataBulkResult object, which is returned by the bulkInsert(), bulkSave(), and bulkUpdate() functions. (March 15, 2021)

Updated: Added information when getItem() returns null

We added information that if an item doesn't exist, getItem() returns null. (March 15, 2021)

New API: onAudioTranscoded

wix-media-backend

In addition to video files, audio files that are imported or uploaded to the Media Manager require transcoding, and are not immediately available until the transcoding has completed.

Similar to the onVideoTranscoded() API, the new onAudioTranscoded API event handler runs when an uploaded audio file has finished transcoding. (March 10, 2021)

New API Reference Feature: Show Members open by default

The table that lists the properties in a returned object used to be closed by default and would require you to click Show Members to view it. The expandable is now open by default. You can see an example in the Returns table for createProduct. (March 7, 2021)

New Release Notes information

We will now label the latest updates in the Release Notes with     in the heading to make it easier to find the latest changes. (March 7, 2021)

Remove mention of currentItem from the context of some data hooks

wix-data

The context.currentItem parameter is only relevant for beforeUpdate() and beforeRemove() hooks. The property was removed from the documentation for all other hooks. (March 4, 2021)

New API: Bookings Events

wix-bookings-backend

Backend events have been added to Wix Bookings. The events are fired for the following actions:

  • A new booking request is created.
  • A booking request is confirmed or declined.
  • A booking is canceled.
  • A booking schedule is updated.
  • Booking attendance information is updated.

(March 2, 2021)

Clarified opacity and hidden for timeline

wix-animations

  • Updated the target parameter type to Element from mixin.
  • Clarified that only elements that mix in the hiddenMixin can be the target.
  • Clarified that the unit for opacity is from 0.0 - 1.0.

(March 2, 2021)

New API: Price per unit data fields added to product object

wix-stores-backend

Price Per Unit data fields were added to APIs returning product objects and product variant objects. These APIs mirror the Dashboard feature that allows you to display a product's base and total quantity/weight/area. Complies with requirements in the German market. (February 22, 2021)

New API: Pricing Plans: Plan management

wix-pricing-plans-backend

With the new pricing-plans-backend APIs, you can manage your APIs in ways that before, you could only do from the Dashboard.

Now you can create, update, hide, and archive pricing plans. You can set and clear which pricing plan is the primary plan and rearrange the order in which plans are displayed on the site. And we now supply different ways for you to get information about existing plans, such as getting a single plan, getting statistics for a plan, listing public/all plans, and performing queries. (February 7, 2021)

New API Reference Feature: Release Notes change indicator

A red dot now appears next to the Release Notes section in the left tree when it is updated. More enhancements on the way. (February 3, 2021)

Updated: getSecret does not require Members Area

wix-secret-backend

We removed a note that said you need the Members Area on your site to work with the getSecret() API. (February 3, 2021)

Updated: Slot Id parameter fixed

wix-bookings

We changed slot_id to slotId in getCheckoutOptions(). (February 3, 2021)

Updated: getCurrentMemberOrders returns a promise

wix-paid-plans

getCurrentMemberOrders() returns a promise that resolves to an array. We previously stated that the function returns an array. (February 3, 2021)

Updated: cancelOrder throws an error

wix-paid-plans

We clarified that cancelOrder throws an error when Allow Plan Cancellation is set to False in the Dashboard. (February 3, 2021)

Updated: Recommend using getCurrentGeolocation with setTimeout

wix-window

In cases where the site visitor's browser is set to not detect locale, the promise does not resolve or reject. We added a note recommending using getCurrentGeoLocation() with setTimeout to handle the unresolved Promise. (February 3, 2021)

Updated: Hooks run when data is imported

wix-data

We added a note that the beforeInsert and afterInsert hooks run when data is imported to either Live or Sandbox collections. (February 3, 2021)

Updated: queryReferenced() only works with multiple-item reference fields

wix-data

We added a note that you can only use the queryReferenced() function with multiple-item reference fields and not with single-item (regular) reference fields. (February 3, 2021)

Updated: Use the checked property with the Switch element

Wix Editor Elements ($w)

The value property does not work with the Switch element. We added a note to use the checked property instead. We also added an example for using the checked property to set the Switch state. (February 3, 2021)

Updated: RichTextBox does not support KeyboardEvent and onInput

Wix Editor Elements ($w)

KeyboardEvent doesn’t fire and onInput is not supported for RichTextBox elements. We removed a reference to the RichTextBox element from the KeyboardEvent documentation and added a note to onInput that it is not supported for RichTextBox elements. (February 3, 2021)

Updated: SelectionTags options property changes

Wix Editor Elements ($w)

Setting the options property no longer clears the value and selectedIndices of the selection tags. This allows users to add and reorder choices without clearing the visitor's selection. Only values that no longer match the new options are cleared.

Setting value no longer lets you set values that do not match any of the options. (February 3, 2021)

Updated: formattedPrice and formattedDiscountedPrice are read-only

wix-stores-backend

We removed a reference to formattedPrice and formattedDiscountedPrice fields for updateVariantData() since they are read-only and can't be set. (February 3, 2021)

Updated: SSL note in wixWindow.openModal()

wix-window

It is not possible to turn SSL off with Velo. We removed a part of the note that was misleading. (January 20, 2021)

New API: Coupons events

wix-marketing-backend

With the new Coupon backend events you can write code that is triggered when a coupon is created, updated, deleted, or applied. (January 19, 2021)

New API: Added appID to Coupons API

wix-marketing-backend

Added the appID property to the CouponEvent object. The ID of the app that created the coupon. Empty if created by the site owner. (January 19, 2021)

Updated: update

erInfo deletes any non-updated properties

wix-bookings-backend

Updated an example and added a note that updateCustomerInfo() updates the entire object and that any properties not included in the object passed will be deleted. (January 14, 2021)

New API: Cancel & Refund events

wix-stores-backend

With the new onOrderRefunded() & onOrderCanceled() backend events you can now write code that is triggered when an order is refunded and/or canceled. (January 14, 2021)

New API: Bookings backend

wix-bookings-backend

Backend APIs are now available to manage Bookings. The wix-bookings-backend API provides bookings functionality allowing you to:

  • List and query booking information.
  • Confirm pending booking requests.
  • Decline pending booking requests.
  • Cancel a booking.
  • Set attendance for booked sessions.
  • Mark a booking as paid.
  • Update the customer's booking information.

(January 12, 2021)

New API: Increment inventory

wix-stores-backend

With the new Wix Stores incrementInventory() API you can increment a product variant's stock in the store's inventory. Pass a variantId and either a productID or an inventoryId, as well as the integer to increment by. (December 31, 2020)

Updated: Added multiple locations to ServiceAvailability object

wix-bookings

The ServiceAvailability object returned by getServiceAvailability() now includes a location property. If the service is offered in multiple locations, a slot is returned for each location. (December 30, 2020)

Updated: Upload button now indicates if a file fails to upload

Wix Editor Elements ($w)

The valid property of UploadButton is set to false when a file fails to upload. Previously this was only set if required == TRUE. (December 27, 2020)

Updated: openLightbox requires onReady

wix-window

Even though openLightbox() is not part of $w it can only be called after the onReady event has fired. (December 27, 2020)

Updated: Wix Data is eventually consistent

wix-data

The wix-data API is eventually consistent, meaning that sometimes updates to your database collection are not immediate. There may be a short delay until the system is up-to-date with your recent changes. During the delay, the data you get back may not reflect those changes. (December 27, 2020)

API Updated: Added seoData field to the Product object

We added the seoData field to the Product object. This mirrors the SEO data added in the dashboard and allows for adding custom SEO tags when using createProduct(). (December 27, 2020)

Updated: Editor elements ($w) progressBar.value is a get or set

Wix Editor Elements ($w)

We incorrectly stated that you could only “get” the value of the ProgressBar element. We clarified that you can both “get” and “set” the value property. (December 24, 2020)

Updated: bulkUpdate clarification

wix-data

We were a bit vague about how bulkUpdate() works. We now stress in the explanation that bulkUpdate replaces all properties of the existing, matching items. When specifying which properties you want to update, the values of any properties that are not specified are lost. (December 24, 2020)

New API: privacyStatus property for register function in wix-users and wix-users-backend

wix-users

wix-users-backend

There is a new privacyStatus parameter for the register() function. Options are PUBLIC and PRIVATE. (December 24, 2020)

Updated: Clarified creation of routers.js file

wix-router

The introduction implied that the user needs to create the routers.js file. Actually, when you set up your router, the file is created for you. We clarified that you do not need to manually create the routers.js file.

We also reviewed the existing explanations and made some updates, including:

  • How to work with routers, based on changes made in the Editor.
  • How we explain the URL needed for WixRouterRequest.
  • Adding and fixing links.
  • Fixing a typo in an example.

(December 24, 2020)

New API: wix-users-backend Roles

wix-users-backend

We added the assignRole() and removeRole()functions to the new Roles API in wix-users-backend, allowing you to manage site member access to restricted pages. (December 24, 2020)

New API: VideoBox

Wix Editor Elements ($w)

Velo's APIs are now available to control how videos play in VideoBox elements on your site. Video boxes allow you to showcase your videos in beautifully-designed video containers. Unlike VideoPlayer elements, VideoBox elements do not have controls, text descriptions, titles and cannot be displayed in full screen mode. This gives video boxes a clean look. You can use the APIs to manage video boxes for:

  • Videos uploaded to your site
  • Transparent videos uploaded to your site
  • Videos/Transparent videos from the Wix Media library

(December 7, 2020)

Updated: textInput.maxLength remove max length

Wix Editor Elements ($w)

The instructions to remove the maximum length restriction incorrectly stated to set maxLength to 0. We clarified that you can format the text using the html property. (December 7, 2020)

Updated: text styles

We listed the supported styles and formats for text type elements but did not explain how to use them. We clarified that you can format the text using the html property. (December 7, 2020)

Updated: uploadButton.reset

Wix Editor Elements ($w)

We clarified that the reset() function clears the files in the value property. (December 7, 2020)

Updated: radioButtonGroup options

Wix Editor Elements ($w)

The description incorrectly stated that options is an object. We clarified that options is an array of option objects. (December 7, 2020)

Updated: getCheckoutOptions slotID

wix-bookings

In the getCheckoutOptions() parameter table, slot_ID was formatted incorrectly. The correct format is slotID. (December 7, 2020)

Updated: wixWindow.scrollTo coordinates

wix-window

In the scrollTo() function we didn’t mention how to get the coordinates of a given location. We added how to get the coordinates of a location on the page using the Editor toolbar. (December 7, 2020)

Updated: wixLocation URL structure

wix-location

The layout for describing the different parts of the URL was a bit confusing. We changed the URL breakdown to match the same layout as the wixHttpFunctionRequest object in the wix-http-functions API for consistency. (December 7, 2020)

New API: Wix Forum Backend Event APIs

wix-forum-backend

With the new Forum Backend Events you can react to activity on your forum. You can run custom code when forum categories, posts, and comments are created, updated, deleted, posted, pinned, voted on, liked, reported, and more. For example, you can send a custom email to a poster when their post is liked, display a message when a comment is marked as best, or set up an alert when a post or comment is reported. (November 1, 2020)

New API: removeProductFromCart

wix-stores

With removeProductFromCart() you can remove a line item/product from the cart. (November 1, 2020)

New API: onWixFormSubmit() event handler in the WixForms API

wix-crm

With the new onWixFormSubmit() event handler in the WixForms API, you can perform validations on your forms immediately after visitors submit the form yet before the server starts any processing. (October 20, 2020)

Updated: wixLocation.to() does not work in preview

wix-location

Added a note that wixLocation.to() only works on a published site and not while previewing. (October 13, 2020)

Updated: htmlComponent can only embed a PDF file with a Premium account

$w.HtmlComponent

To embed a PDF in an HtmlComponent you must upgrade your site to a Premium Plan. (October 13, 2020)

New API: Decrement inventory

wix-stores-backend

Manually decrement a product variant's stock in inventory. This functionality is helpful for creating an inventory management page on your site. (October 11, 2020)

Updated: Added Stackdriver information to Site Monitoring introduction

site-monitoring

Added information about connecting Wix site events to Google's Stackdriver external monitoring tool. (September 16, 2020)

Updated: Changed slider.value from read only to read & write

$w.slider

The value property for the Slider element was described as read only but it should be read and write. (September 15, 2020)

Updated: Added more information for returned object properties from Validity property

ValidatableMixin

Added more content to the table that displays details of the object returned by validity. (September 15, 2020)

Updated: Added information that some getProductVariants() parameter fields are optional

wix-stores

Added information that some of the parameter fields for getProductVariants() are optional. (September 14, 2020)

Updated: createProduct() SKU is a string

stores-backend

The sku property for createProduct() was described as a number, but it is a string. (September 14, 2020)

Updated: Added information about getFileURL token expiring

wix-media-backend

Added information that the token returned by getFileUrl() expires after 600 minutes. Described the alternative of creating a static URL without a token. (September 10, 2020)

Updated: The URL table for wixHttpFunctionRequest

wix-http-functions

The table that described the URL structure of a wixHttpFunctionRequest was difficult to parse. We've updated the content to make it easier to understand. (September 10, 2020)

New API: On cart changed event

wix-stores

With the new onCartChanged() client-side event in wix-stores, you can access information about the site's shopping cart every time an item is added or removed. Useful for creating a promotional lightbox - if product X is added to the cart, offer product Y. (September 7, 2020)

New API: Consent policy (privacy laws)

wix-users

To help your site conform to GDPR and CCPA standards, we now provide Velo APIs for checking and setting visitors' current consent policies. These policies include which cookies the visitor allows and if the visitor allows data transfer to third parties. (September 7, 2020)

Updated: Added examples to listMemberBadges()

wix-users-backend

Added more robust examples to listMemberBadges() for how to handle the results. (August 30, 2020)

New API: Coupon limit per customer

wix-marketing-backend

Use the new limitPerCustomer property that allows for limiting coupon use per customer. Helpful if you'd like to create a coupon to be used only once, or any number of times per customer. (August 23, 2020)

New API: Custom fulfiller email

wix-stores-backend

Use the new sendFulfillmentEmail() function to send an email containing fulfillment details (products to ship, shipping details, etc.) to a custom fulfiller (a fulfiller not integrated with Wix, like ShipBob or ShipStation). (August 20, 2020)

New API: Order paid event

wix-stores-backend

Added a new event that fires when an order is marked as paid. (August 20, 2020)

Updated: New array and object data types

wix-data

Added information about new array and object types to the wix-data Introduction. (August 12, 2020)

New API: Print packing slip

wix-stores-backend

Use the new getPackingSlipLink() function to generate and print a PDF file of an order's packing slip. Especially useful in the ThankYouPage, after an order is completed. (August 11, 2020)

Updated: New validations for file upload

wix-media-backend

The Upload button can now perform certain validations right after file selection. (August 9, 2020)

Updated: Mark createContact() parameters as optional

wix-crm

Changed the contactInfo parameters for createContact() to be optional. (August 9, 2020)

New API: Print orders

wix-stores-backend

Use the new getOrdersLink() function to generate a PDF file containing information about one of more of your store's orders. (August 6, 2020)

Updated: New example for onItemReady()

$w.repeater

Added a simple onItemReady() example where onItemReady() is triggered when repeater data is set. (August 3, 2020)

Updated: New example for WixDataQuery.include()

wix-data

Added new example in WixData.query.include() to show how to use a reference field from another collection when populating a table with DataPath. (August 3, 2020)

Updated: Router examples should use https for imageSite links

wix-router

The A router with static data example for the router() function used http URLs in the example for imageSite. They were updated to use https. (August 3, 2020)

Updated: Secrets API

wix-secrets-backend

With the new Secrets API functions you can manage your site secrets with code. Create, update, and delete secrets in the Secrets Manager programmatically without opening the UI. List all your site secrets to find the one you need. (August 2, 2020)

New API: Fulfillment

wix-stores-backend

Use the createFulfillment() function to create, update, and delete order fulfillments (as well as set up events for each). (July 30, 2020)

New API: Create order

wix-stores-backend

Use the createOrder() function to have more control over various order properties, allowing for more custom order flows. (July 30, 2020)

New API: Form Builder

wix-crm wix-crm-backend

With the new Wix Forms APIs, you can access Wix Form app functionality with code. You can customize how site visitors work with the Wix Form, while taking advantage of the Wix Forms app's ease of design, automatic creation of submission collections, payment receipt, automatic setup of email notifications, and more. You can perform actions both on the client side and in the backend. (July 28, 2020)

Updated: Badges

wix-users-backend

With the new Badges APIs you can manage your member badges with code. Create, update, and delete badges, assign and remove badges from members, and see which members are associated with each badge. (July 9, 2020)

Updated: Add information about import and export triggering before and after query hooks

wix-data

Added information that before and after query hooks are triggered when items are exported from a collection. (July 9, 2020)

Did this help?