Search.../

Developer Preview

Velo is always in active development, and we're constantly adding new APIs. We want to make sure that we're on the right track and building the functionality that you need. For this reason, we release some of the APIs we're still working on in Developer Preview mode for user testing. This is a way for us to get feedback from you and improve our APIs before we fully release them.

APIs in Developer Preview mode include the following warning in their introductions:

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

They also include this tag in the reference for each function:
developer preview tag
Once these tags are removed, the API is fully released.

Here is some important information to know about Developer Preview:

Breaking changes

APIs in Developer Preview are still in development. This means that we may change them at any time. Notifications about breaking changes appear in the release notes and in the API reference for the affected functions and properties. We will not contact you directly about breaking changes.

Because we may introduce breaking changes to these APIs, you shouldn't use them on live sites. They are for testing and feedback purposes only.

Time limit

APIs only stay in Developer Preview mode for a maximum of 6 months. After that they are fully released, and we don't make any breaking changes to them.

You can see which APIs are in Developer Preview in the table below. You can also check the API documentation in the reference to see if the developer preview tags have been removed.

Feedback

We would appreciate 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.

Please email us with your feedback.

Bugs

If you discover a bug in a Developer Preview API, please email us and let us know. We'll fix the bug as soon as possible.

Current Developer Preview APIs

This is a list of the APIs that are currently in Developer Preview mode.

ModuleSubmoduleFunction
wix-activity-counters.v2ActivityCountersQueryBuildereq
find
in
limit
ne
skip
wix-activity-counters.v2ActivityCountersgetActivityCounters
queryActivityCounters
setActivityCounters
wix-blog-backendEventsonTagUpdated
wix-bookings.v1ResourcesdeleteResource
wix-bookings.v2AttendancesQueryBuilderascending
descending
eq
find
ge
gt
in
le
limit
lt
ne
skipTo
wix-bookings.v2AttendancegetAttendance
queryAttendance
setAttendance
wix-bookings.v2AvailabilityCalendarqueryAvailability
wix-bookings.v2BookingsbulkCreateBooking
cancelBooking
confirmBooking
confirmOrDeclineBooking
createBooking
declineBooking
rescheduleBooking
updateNumberOfParticipants
wix-bookings.v2EventsonBookingCanceled
onBookingConfirmed
onBookingCreated
onBookingDeclined
onBookingNumberOfParticipantsUpdated
onBookingRescheduled
onServiceOptionsAndVariantsCreated
onServiceOptionsAndVariantsDeleted
onServiceOptionsAndVariantsUpdated
wix-bookings.v2ExtendedBookingsqueryExtendedBookings
wix-bookings.v2ExternalCalendarsconnectByCredentials
connectByOAuth
disconnect
getConnection
listCalendars
listConnections
listEvents
listProviders
updateSyncConfig
wix-bookings.v2PricingcalculatePrice
previewPrice
wix-bookings.v2ServiceOptionsAndVariantsListQueryBuilderascending
descending
eq
exists
find
hasSome
in
limit
ne
skipTo
wix-bookings.v2ServiceOptionsAndVariantscloneServiceOptionsAndVariants
createServiceOptionsAndVariants
deleteServiceOptionsAndVariants
getServiceOptionsAndVariants
getServiceOptionsAndVariantsByServiceId
queryServiceOptionsAndVariants
updateServiceOptionsAndVariants
wix-bookings.v2ServicesQueryBuildereq
exists
find
hasAll
hasSome
in
limit
ne
skip
startsWith
wix-bookings.v2ServicesgetService
queryServices
wix-business-tools.v2EventsonLocationArchiveStatus
onLocationCreated
onLocationSetDefaultLocation
onLocationUpdated
wix-business-tools.v2LocationsarchiveLocation
createLocation
getLocation
listLocations
queryLocations
setDefaultLocation
updateLocation
wix-business-tools.v2SitePropertiesgetSiteProperties
updateBusinessContact
updateBusinessProfile
updateBusinessSchedule
updateConsentPolicy
wix-captcha.v2Captchaauthorize
wix-comments.v2CommentsQueryBuilderascending
descending
eq
find
ge
gt
in
le
limit
lt
ne
skipTo
wix-comments.v2CommentscountComments
createComment
deleteComment
getComment
markComment
queryComments
unmarkComment
updateComment
wix-comments.v2EventsonCommentCreated
onCommentDeleted
onCommentMarked
onCommentUnmarked
onCommentUpdated
wix-crm.v2ContactsQueryBuilderascending
descending
eq
exists
find
gt
hasSome
in
limit
lt
ne
skip
startsWith
wix-crm.v2ContactscreateContact
deleteContact
getContact
labelContact
mergeContacts
unlabelContact
updateContact
wix-crm.v2EventsonLabelCreated
onLabelDeleted
onLabelUpdated
wix-crm.v2FieldsQueryBuilderascending
descending
eq
find
gt
in
le
limit
lt
ne
skip
startsWith
wix-crm.v2ExtendedFieldsdeleteExtendedField
getExtendedField
queryExtendedFields
renameExtendedField
wix-crm.v2LabelsQueryBuilderascending
descending
eq
find
gt
in
le
limit
lt
ne
skip
startsWith
wix-crm.v2LabelsdeleteLabel
getLabel
queryLabels
renameLabel
wix-crm.v2TaskscreateTask
getTask
removeTask
updateTaskFields
updateTaskStatus
wix-data.v2CollectionscreateDataCollection
deleteDataCollection
getDataCollection
listDataCollections
updateDataCollection
wix-data.v2EventsonExternalDatabaseConnectionCreated
onExternalDatabaseConnectionDeleted
onExternalDatabaseConnectionUpdated
wix-data.v2ExternalDatabaseConnectionscreateExternalDatabaseConnection
deleteExternalDatabaseConnection
getExternalDatabaseConnection
listExternalDatabaseConnections
updateExternalDatabaseConnection
wix-data.v2IndexescreateIndex
dropIndex
listIndexes
wix-ecom-backendRequestsQueryBuilderascending
descending
eq
exists
find
ge
gt
in
le
limit
lt
ne
skipTo
startsWith
wix-ecom-backendBackInStockNotificationscreateBackInStockNotificationRequest
deleteBackInStockNotificationRequest
getBackInStockNotificationRequest
getBackInStockNotificationRequestsCountByCatalogReferences
markAsNotificationSent
queryBackInStockNotificationRequests
reportItemsBackInStock
wix-ecom-backendBackInStockSettingsgetSettings
startCollectingRequests
stopCollectingRequests
wix-ecom-backendCheckoutcreateOrder
getCheckoutUrl
removeOverrideCheckoutUrl
wix-ecom-backendCheckoutSettingsgetCheckoutSettings
updateCheckoutSettings
wix-ecom-backendDiscountRulesQueryBuilderascending
descending
eq
exists
find
ge
gt
in
le
limit
lt
ne
skipTo
startsWith
wix-ecom-backendDiscountRulescreateDiscountRule
deleteDiscountRule
getDiscountRule
queryDiscountRules
updateDiscountRule
wix-ecom-backendEventsonAbandonedCheckoutCreated
onAbandonedCheckoutRecovered
onBackInStockNotificationRequestCreated
onBackInStockNotificationRequestDeleted
onBackInStockNotificationRequestUpdated
onCheckoutSettingsUpdated
onDiscountRuleCreated
onDiscountRuleDeleted
onDiscountRuleUpdated
onOrderApproved
onOrderCanceled
onOrderUpdated
onOrdersSettingsUpdated
wix-ecom-backendOrderTransactionslistTransactionsForMultipleOrders
listTransactionsForSingleOrder
wix-ecom-backendOrderscancelOrder
wix-ecom-backendOrdersSettingsgetOrdersSettings
updateOrdersSettings
wix-ecom-backendRecommendationsgetRecommendation
listAvailableAlgorithms
wix-ecom.v2CurrenciesconvertCurrency
getConversionRate
listCurrencies
wix-email-marketing.v2AccountDetailsgetAccountDetails
wix-email-marketing.v2CampaignsdeleteCampaign
getCampaign
listCampaigns
listRecipients
listStatistics
pauseScheduling
publishCampaign
reuseCampaign
sendTest
wix-email-marketing.v2SenderDetailsgetSenderDetails
resolveActualFromAddress
updateSenderDetails
verifyEmail
wix-events.v2CheckoutcancelReservation
checkout
createReservation
getCheckoutOptions
getInvoice
listAvailableTickets
queryAvailableTickets
updateCheckout
wix-events.v2EventsonPolicyCreated
onPolicyDeleted
onPolicyUpdated
wix-events.v2GuestsQueryBuilderascending
descending
eq
exists
find
gt
in
le
limit
lt
ne
skipTo
wix-events.v2GuestsqueryGuests
wix-events.v2OrdersbulkUpdateOrders
confirmOrder
getOrder
getSummary
listOrders
updateOrder
wix-events.v2PoliciesQueryBuilderascending
descending
eq
exists
find
ge
gt
in
le
limit
lt
ne
skipTo
wix-events.v2PoliciescreatePolicy
deletePolicy
getPolicy
queryPolicies
reorderEventPolicies
updatePolicy
wix-events.v2TicketDefinitionschangeCurrency
createTicketDefinition
deleteTicketDefinition
getTicketDefinition
listTicketDefinitions
queryTicketDefinitions
updateTicketDefinition
wix-events.v2TicketsbulkUpdateTickets
checkInTickets
deleteTicketCheckIns
getTicket
listTickets
updateTicket
wix-forms.v2SubmissionsQueryBuilderascending
descending
eq
find
gt
in
le
limit
lt
ne
skipTo
wix-forms.v2SubmissionsbulkMarkSubmissionsAsSeen
confirmSubmission
countSubmissions
createSubmission
deleteSubmission
getMediaUploadUrl
getSubmission
querySubmissionsByNamespace
updateSubmission
wix-forum.v2CategoriesgetCategory
getCategoryBySlug
queryCategories
wix-forum.v2EventsonCategoryCreated
onCategoryDeleted
onCategoryUpdated
onPostClosed
onPostCreated
onPostDeleted
onPostLiked
onPostMoved
onPostOpened
onPostPinned
onPostReacted
onPostReported
onPostUnliked
onPostUnpinned
onPostUnreacted
onPostUpdated
wix-forum.v2PostsgetPost
getPostBySlug
queryPosts
wix-groups.v2GroupRequestsQueryBuildereq
exists
find
hasSome
in
limit
ne
skip
wix-groups.v2CreateRequestsapproveGroupRequests
listGroupRequests
queryGroupRequests
rejectGroupRequests
wix-groups.v2EventsonGroupMemberAdded
onGroupMemberRemoved
onJoinGroupRequestApproved
onJoinGroupRequestRejected
wix-inbox.v2ConversationsgetConversation
getOrCreateConversation
wix-inbox.v2EventsonMessageButtonInteracted
onMessageSentToBusiness
onMessageSentToParticipant
wix-inbox.v2MessageslistMessages
sendMessage
wix-loyalty.v2AccountsadjustPoints
createAccount
earnPoints
getAccount
getAccountBySecondaryId
getProgramTotals
getTransaction
listAccounts
listTransactions
wix-loyalty.v2CouponsdeleteLoyaltyCoupon
getCurrentMemberCoupons
getLoyaltyCoupon
queryLoyaltyCoupons
redeemCurrentMemberPointsForCoupon
redeemPointsForCoupon
wix-loyalty.v2EventsonCouponCreated
onCouponDeleted
onRewardCreated
onRewardDeleted
onRewardUpdated
onTierCreated
onTierDeleted
onTierUpdated
wix-loyalty.v2ProgramsactivateLoyaltyProgram
getLoyaltyProgram
updateLoyaltyProgram
wix-loyalty.v2RewardscreateReward
deleteReward
getReward
listRewards
updateReward
wix-loyalty.v2TiersbulkCreateTiers
createTier
deleteTier
getTier
getTiersProgramSettings
listTiers
updateTier
updateTiersProgramSettings
wix-marketing-tags.v2MarketingTagsdeleteMarketingTag
listMarketingTags
upsertMarketingTag
wix-marketing.v2CouponsbulkCreateCoupons
bulkDeleteCoupons
getCoupon
queryCoupons
wix-media.v2EventsonFileDescriptorDeleted
onFileDescriptorFileFailed
onFileDescriptorFileReady
onFileDescriptorUpdated
onFolderCreated
onFolderDeleted
onFolderUpdated
wix-media.v2FilesbulkDeleteFiles
bulkImportFile
bulkImportFiles
bulkRestoreFilesFromTrashBin
generateFileResumableUploadUrl
generateFileUploadUrl
generateFilesDownloadUrl
generateVideoStreamingUrl
getFileDescriptor
getFileDescriptors
importFile
listDeletedFiles
listFiles
searchFiles
updateFileDescriptor
wix-members.v2BadgesgetBadge
getMemberCountsPerBadge
updateBadgesDisplayOrder
wix-members.v2EventsonBadgeAssigned
onBadgeCreated
onBadgeDeleted
onBadgeUnassigned
onBadgeUpdated
wix-members.v2MembersQueryBuildereq
exists
find
hasSome
in
limit
ne
skip
startsWith
wix-members.v2MemberscreateMember
getCurrentMember
listMembers
queryMembers
updateCurrentMemberSlug
wix-notifications.v2Notificationsnotify
wix-pricing-plans.v2EventsonOrderAutoRenewCanceled
onOrderCanceled
onOrderCreated
onOrderCycleStarted
onOrderEndDatePostponed
onOrderEnded
onOrderMarkedAsPaid
onOrderPaused
onOrderPurchased
onOrderResumed
onOrderStartDateChanged
onOrderStarted
onOrderUpdated
onPlanUpdated
wix-pro-gallery-backendProGallerycreateGallery
createGalleryItem
deleteGallery
deleteGalleryItem
getGallery
getGalleryItem
listGalleries
listGalleryItems
updateGallery
updateGalleryItem
wix-reviews.v2EventsonReviewCreated
onReviewDeleted
onReviewModerationStatusChanged
onReviewUpdated
wix-reviews.v2ReviewsQueryBuilderascending
descending
eq
find
ge
gt
in
le
limit
lt
ne
skipTo
wix-reviews.v2ReviewscreateReview
deleteReview
getReview
queryReviews
updateReview
wix-secrets-backend.v2SecretscreateSecret
deleteSecret
getSecretValue
listSecretInfo
updateSecret
wix-stores.v2InventorygetInventoryVariants
updateInventoryVariants
wix-stores.v2ProductsQueryBuilderascending
descending
eq
exists
find
ge
gt
hasAll
hasSome
in
le
limit
lt
ne
skip
startsWith
wix-stores.v2ProductsbulkAdjustProductProperty
bulkUpdateProductsProperty
createCollection
createProduct
deleteCollection
getProduct
getStoreVariant
queryProductVariants
queryProducts
queryStoreVariants
removeBrand
removeRibbon
resetAllProductVariantData
updateCollection
updateProduct
updateProductVariants
wix-table-reservations.v2EventsonReservationCreated
onReservationLocationCreated
onReservationLocationUpdated
onReservationUpdated
wix-table-reservations.v2ReservationLocationsQueryBuildereq
find
in
limit
ne
skipTo
wix-table-reservations.v2ReservationLocationsgetReservationLocation
listReservationLocations
queryReservationLocations
updateReservationLocation
wix-table-reservations.v2ReservationsQueryBuilderascending
descending
eq
find
ge
gt
in
le
limit
lt
ne
skipTo
wix-table-reservations.v2ReservationscancelReservation
createHeldReservation
createReservation
getReservation
listReservations
queryReservations
reserveReservation
updateReservation
wix-table-reservations.v2TimeSlotsgetTimeSlots
wix-workflows.v2PhasesmovePhase

Was this helpful?