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.
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 email 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:
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 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:
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:
(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)
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 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:
(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)
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: 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: 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 supressAuth 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().
Learn more:
https://www.wix.com/velo/reference/wix-stores/cart/introduction
https://www.wix.com/velo/reference/wix-stores/product/introduction
(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: 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)
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: 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: 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: 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)
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)
Was this helpful?