About Developer Preview

Wix is always in active development, constantly adding new APIs. To ensure we're building the functionality you need, some APIs are released in Developer Preview mode for developer testing and feedback before full release.

APIs in Developer Preview mode include the following note in their introductions. When this note is removed, the API is fully released.

Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Breaking changes

APIs in Developer Preview are still in development. This means that Wix may change them at any time. Notifications about breaking changes appear in the changelog and in the API reference for the affected methods and properties. Wix won't contact you directly about breaking changes.

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

Time limit

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

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 contact us with your feedback.

Bugs

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

Methods in developer preview

The following methods are currently in developer preview:

AI Credits

MethodDescription
Get BalanceRetrieves an account's current AI credit balance.

Account V1

MethodDescription
Get Connect UrlRetrieves a channel's OAuth authorization URL that a site owner opens to connect the channel.
Get Long Lived Token StatusRetrieves the connection status of a site's social channel account.
List AccountsRetrieves the connected accounts for a social channel.
DisconnectDisconnects a social channel account from the site.
Update Account SettingsUpdates the settings for a connected social channel account, such as the default page, board, or account to publish to.

Accounts

MethodDescription
Connect AccountThis endpoint is used to connect a merchant's Payment Service Provider (PSP) account to a Wix site.

Action Catalog

MethodDescription
Get ActionRetrieves a specific version of an action by ID.
Create ActionCreates an action for the specified app
Update ActionUpdates the specified action for the specified app.
Delete ActionDeletes an action from the specified app.
Get Runtime ActionRetrieves the version of an action that's currently active on the site.
Get Latest ActionRetrieves the latest version of an action, regardless of the site on which it's installed.
Get Action Dynamic Input SchemaRetrieves an action's dynamic input schema and UI schema, based on the action's input mapping.
Copy Input MappingRetrieves a copy of an action's input mapping, with any per-action unique values regenerated.
Get Action Dynamic Output SchemaRetrieves an action's dynamic output schema, based on the action's input mapping.
Bulk Get Action Dynamic Output SchemasRetrieves dynamic output schemas for multiple actions in a single request.
Generate Input Mapping From IntentGenerates an action's input mapping from a natural language description of the desired configuration.
Query ActionsRetrieves a list of actions, based on the provided paging, filtering, and sorting.
Query Latest ActionsRetrieves a list of the latest version of each action, based on the provided paging, filtering, and sorting.

Action Provider Service Plugin

MethodDescription
Validate ConfigurationThis method is used to validate a Wix user's action configuration.
Get Quota InfoThis method retrieves quota information for an action.
InvokeRuns your action.

Add-Ons

MethodDescription
Create Add OnCreates an add-on.
Get Add OnRetrieves an add-on.
Delete Add OnDeletes an add-on and removes it from all add-on groups.
Update Add OnUpdates an existing add-on.
Query Add OnsRetrieves up to 100 add-ons, given the specified filtering, sorting, and paging.
Bulk Create Add OnsCreates multiple add-ons in a single request.
Bulk Update Add OnsUpdates multiple add-ons in a single request.
Bulk Delete Add OnsDeletes multiple add-ons in a single request.

Additional Fees Service Plugin

MethodDescription
Calculate Additional FeesRequests calculation of additional fees from the service plugin implementer for a given cart or checkout.

App Installations

MethodDescription
Query App InstallationsRetrieves a list of up to 100 app installations, with the specified paging, filtering, and sorting.
Search App InstallationRetrieves a list of up to 100 app installations that match a free-text search expression.

Attendance

MethodDescription
Count AttendancesCounts attendance records for the calling member

Authentication

MethodDescription
Change PasswordChanges the password of a logged-in member
Sign OnAuthenticates a member without credentials and returns a session token.
LogoutTerminates the member's session and clears authentication cookies.

Availability Time Slots Configuration Service Plugin

MethodDescription
List Availability Time Slot ConfigurationsRetrieves availability time slot configurations for the specified services.

Booking Policy Service Plugin

MethodDescription
List Booking PoliciesRetrieves booking policies for the specified services.

Bookings Validation Service Plugin

MethodDescription
Validate Before CreateValidates whether a booking can be created.
Validate Before CancelValidates whether a booking can be canceled.
Validate Before RescheduleValidates whether a booking can be rescheduled to a new time slot.
Validate Before Create Multi ServiceValidates whether a multi-service booking can be created.
Validate Before Cancel Multi ServiceValidates whether a multi-service booking can be canceled.
Validate Before Reschedule Multi ServiceValidates whether a multi-service booking can be rescheduled.

Bookings Writer V2

MethodDescription
Cancel Booking AnonymouslyCancels a booking using an anonymous token.
Reschedule Booking AnonymouslyReschedules a booking to a new slot using an anonymous token.
Get Booking AnonymouslyRetrieves a booking and its allowed anonymous actions using an anonymous token.
Get Service AnonymouslyRetrieves the service associated with a booking using an anonymous token.
Get Anonymous Action TokenGenerates an anonymous action token for a booking.

Bulk Downloads

MethodDescription
List My Bulk DownloadsLists all bulk downloads available for the user that initiated them
Initiate Bulk DownloadInitiates a bulk download process.
Get Bulk DownloadRetrieves a bulk download.
Delete Bulk DownloadDeletes a bulk download.

Calendar Event V1

MethodDescription
Create EventCreates a calendar event.
Query EventsRetrieves events that occur within a given date range.
Update EventUpdates a calendar event.
Delete EventDeletes a calendar event.

Captcha

MethodDescription
AuthorizeAuthorizes a CAPTCHA token.

Categories

MethodDescription
Get Category By SlugRetrieves a category by its slug.
Create CategoryCreates a new category.
Get CategoryRetrieves a category by ID.
Delete CategoryDeletes a category.
Update CategoryUpdates a category.
Query CategoryRetrieves a list of categories, with the specified paging, filtering, and sorting.

Compliance Review Request V1

MethodDescription
Request ReviewSubmits a CMS compliance action on a data item for review.

Component Type Data V1

MethodDescription
Get Component Types Display DataRetrieves display metadata for the available component types.

Components Service

MethodDescription
Create ComponentCreates a component.
Upsert ComponentsCreates or updates multiple components for a single app.
Get ComponentRetrieves a component by ID.
Delete ComponentDeletes a component's draft version.
Update ComponentUpdates a component.
Get Draft App ComponentsRetrieves the draft version of each of an app's components.
Get Components By External IdRetrieves an app's components that have the specified external ID.
Query ComponentRetrieves a list of up to 50 components, given the provided paging, filtering, and sorting.
Get Max Version Of App ComponentsRetrieves the latest version number of each of an app's components.
Restore Deleted ComponentRestores a deleted component.
Validate ComponentsValidates components for a single app.

Contacts V5

MethodDescription
Bulk Update Contact SubscriptionsUpdates the email and SMS marketing subscription statuses of multiple contacts that match the provided filter
Create ContactCreates a contact.
Get ContactRetrieves a single contact by ID.
Delete ContactDeletes a contact.
Update ContactUpdates a contact.
Upsert ContactCreates a contact, or updates an existing one when a match is found based on the contact's identifiers.
Update Contact TagsAdds or removes tags on a contact.
Merge ContactsMerges up to 5 source contacts into a target contact.
Find Matching ContactsRetrieves a list of up to 100 contacts that match the provided identifiers.
Query ContactsRetrieves a list of up to 100 contacts, given the provided filtering, sorting, and cursor paging.
Search ContactsRetrieves a list of contacts using a free-text search combined with filtering and sorting.
Count ContactsRetrieves the number of contacts that match the provided filter and search criteria.
Generate Contact Image Upload UrlGenerates an upload URL to allow external clients to upload a contact image
Add Contact Additional EmailAdds an additional email to a contact.
Add Contact Additional PhoneAdds an additional phone to a contact.
Add Contact AddressAdds an address to a contact.
Delete Contact AddressDeletes an address from a contact by address ID.
Update Contact AddressUpdates an address on a contact.
Bulk Create ContactsCreates multiple contacts in a single request
Bulk Update ContactsUpdates multiple contacts in a single request
Bulk Update Contact TagsAdds or removes tags on multiple contacts, specified by contact ID
Bulk Update Contact Tags By FilterAdds or removes tags on multiple contacts that match the provided filter
Bulk Upsert ContactsCreates or updates multiple contacts in a single request
Bulk Delete ContactsDeletes multiple contacts in a single request
Bulk Delete Contacts By FilterDeletes multiple contacts that match the provided filter
Get Deleted ContactRetrieves a soft-deleted contact from the trash bin by ID.
Remove Contact From Trash BinPermanently deletes a contact from the trash bin.
Restore Contact From Trash BinRestores a soft-deleted contact from the trash bin.
Bulk Restore Contacts From Trash BinRestores multiple soft-deleted contacts from the trash bin.
List Deleted ContactsRetrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
Get Contact Image Upload StatusRetrieves the status of the contact image upload process.
Bulk Update Phone Country Code By FilterAdds a country code to the main phone of multiple contacts that match the provided filter

Custom Discount Triggers Integration Service Plugin

MethodDescription
List TriggersLists all custom triggers provided by your service plugin integration.
Get Eligible TriggersRetrieves eligible custom discount triggers based on the provided items.

Delivery Profiles

MethodDescription
Create Delivery ProfileCreates a delivery profile.
Get Delivery ProfileRetrieves a delivery profile.
Delete Delivery ProfileDeletes a delivery profile.
Update Delivery ProfileUpdates a delivery profile.
Query Delivery ProfilesRetrieves a list of up to 100 delivery profiles, given the provided paging, filtering, and sorting.
Add Delivery RegionAdds a delivery region to an existing delivery profile.
Update Delivery RegionUpdates a delivery region.
Get Delivery Profile By Delivery Region IdRetrieves a delivery profile by delivery region ID.
Remove Delivery RegionRemoves a delivery region from a delivery profile.
Add Delivery CarrierAdds a delivery carrier to a delivery region.
Remove Delivery CarrierRemoves a delivery carrier from a delivery region.
Update Delivery CarrierUpdates a delivery carrier's settings in a delivery region.
List Installed Delivery CarriersRetrieves a list of all delivery carriers installed on a site.
Get Delivery Destination PropertiesRetrieves delivery destination properties.
List Delivery CarriersRetrieves delivery carrier settings for a delivery profile.
Set Delivery Carrier Active StatusSets a delivery carrier's active status.
Update Extended FieldsUpdates extended fields of a delivery profile without incrementing revision.

Dispute Evidence Documents

MethodDescription
Create Dispute Evidence DocumentCreates a dispute evidence document for a specific dispute.
Get Dispute Evidence DocumentRetrieves a dispute evidence document.
Delete Dispute Evidence DocumentDeletes a dispute evidence document.
Query Dispute Evidence DocumentsRetrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting.
Bulk Update Dispute Evidence Document TagsUpdates tags on multiple dispute evidence documents by ID.
Bulk Update Dispute Evidence Document Tags By FilterAsynchronously updates tags on multiple dispute evidence documents based on filter criteria

Email Subscriptions

MethodDescription
Query Email SubscriptionsRetrieves email subscriptions, given the provided paging, filtering, and sorting.
Upsert Email SubscriptionUpdates or creates an email subscription for the requested email.
Bulk Upsert Email SubscriptionUpdates or creates multiple email subscriptions.
Generate Unsubscribe LinkCreates an unsubscribe link to be shared with the relevant recipient.

External Database Service Plugin

MethodDescription
Query Data ItemsRetrieves a list of items based on the provided filtering, sorting, and paging preferences.
Count Data ItemsCounts the number of items in the specified data collection that match the filtering preferences.
Aggregate Data ItemsRuns an aggregation query on the specified data collection and returns the resulting list of items.
Query Distinct ValuesRetrieves a list of distinct values for a given field for all items that match the query, without duplicates.
Insert Data ItemsAdds one or more items to a collection.
Update Data ItemsUpdates one or more items in a collection
Remove Data ItemsRemoves one or more items from a collection
Truncate Data ItemsRemoves all items from a collection.
Query Referenced Data ItemsRetrieves the items referenced in the specified field of a referring item
Insert Data Item ReferencesInserts one or more item references into a referring field of the specified item.
Remove Data Item ReferencesRemoves one or more item references from a referring field of the specified item.
List CollectionsRetrieves a list of data collections and their details.
Create CollectionCreates a new data collection.
Update CollectionUpdates the structure of an existing data collection.
Delete CollectionDeletes a data collection.
Get CapabilitiesLists the global capabilities the external database supports.

Form Submissions Service Plugin

MethodDescription
Validate Submission

Fulfillment Methods

MethodDescription
List Fulfillment MethodsRetrieves a list of up to 100 fulfillment methods.
Create Fulfillment MethodCreates a new fulfillment method.
Bulk Create Fulfillment MethodsCreate multiple fulfillment methods at once.
Get Fulfillment MethodRetrieves a fulfillment method.
Delete Fulfillment MethodDeletes a fulfillment method.
Update Fulfillment MethodUpdates a fulfillment method.
Query Fulfillment MethodsRetrieves a list of fulfillment methods given the provided paging, filtering, and sorting
List Available Fulfillment Methods For AddressRetrieves a list of up to 100 fulfillment methods available for a given address.
Get Aggregated Method AvailabilityRetrieves the aggregated availability of a list of fulfillment methods.
Bulk Update Fulfillment Method TagsSynchronously update tags on multiple fulfillment methods
Bulk Update Fulfillment Method Tags By FilterAsynchronously update tags on multiple fulfillment methods according to the specified filter

Generated Content V1

MethodDescription
Generate TextGenerates post captions from a text prompt.
Generate ImageGenerates an image from a text prompt and a source image.
Get Generated ImageRetrieves the result of an asynchronous image-generation request.
Generate Post DataGenerates post content for one or more social channels.

Gift Card Products

MethodDescription
Create Gift Card ProductCreates a gift card product.
Get Gift Card ProductRetrieves a gift card product.
Delete Gift Card ProductDeletes a gift card product
Update Gift Card ProductUpdates a gift card product.
Query Gift Card ProductsRetrieves a list of up to 1,000 gift card products, given the provided paging, filtering, and sorting.

Gift Cards Service Plugin

MethodDescription
Get BalanceThis method retrieves gift card data from your app
RedeemThis method requests that a transaction be created by your app
VoidThis method requests that a gift card transaction be voided by your app

Intake Form V1

MethodDescription
Create Intake FormCreates an intake form.
Get Intake FormRetrieves an intake form by ID.
Delete Intake FormDeletes an intake form.
Update Intake FormUpdates an intake form.
Query Intake FormsRetrieves a list of up to 100 intake forms, given the provided paging, filtering, and sorting.
Bulk Create Intake FormsCreates multiple intake forms in a single request.
Bulk Update Intake FormsUpdates multiple intake forms in a single request.
Search Intake FormsSearches intake forms using a free-text expression matched against the client name and project name.
Bulk Delete Intake FormsDeletes multiple intake forms in a single request.

Item Labels

MethodDescription
List LabelsRetrieves a list of up to 500 item labels.
Create LabelCreates an item label.
Get LabelRetrieves an item label by ID.
Delete LabelDeletes an item label.
Query LabelsRetrieves a list of item labels given the provided paging, filtering, and sorting
Update LabelUpdates an item Label.

Item Modifier Groups

MethodDescription
List Modifier GroupsRetrieves a list of up to 500 modifier groups.
Create Modifier GroupCreates a modifier group.
Get Modifier GroupRetrieves a modifier group by the ID.
Delete Modifier GroupDeletes a modifier group.
Query Modifier GroupsRetrieves a list of modifier groups given the provided paging, filtering, and sorting
Count Modifier GroupsRetrieves the number of modifier groups that match a specified filter.
Update Modifier GroupUpdates a modifier group.
Bulk Create Modifier GroupsCreates multiple modifier groups.
Bulk Update Modifier GroupsUpdates multiple item modifier groups at once

Item Modifiers

MethodDescription
List ModifiersRetrieves a list of up to 500 item modifiers.
Create ModifierCreates an item modifier.
Get ModifierRetrieves an item modifier by ID.
Delete Modifier
Update ModifierUpdates an item modifier.
Bulk Create ModifiersCreates multiple item modifiers.
Bulk Update ModifiersUpdates multiple item modifiers at once
Query ModifiersRetrieves a list of item modifiers given the provided paging, filtering, and sorting
Count ModifiersRetrieves the number of modifiers that match a specified filter.
Bulk Delete ModifiersDeletes multiple item Modifiers at once.

Item V1

MethodDescription
Publish ItemPublishes an item to a connected social channel.
Publish Item By IdPublishes a previously created item by its id.
Get ItemsRetrieves a list of items by their IDs.
Create Draft ItemCreates a draft item.
Get ItemRetrieves an item by ID.
Delete ItemDeletes an item.
Query ItemsRetrieves a list of items, given the provided paging, filtering, and sorting.
Cancel Scheduled ItemCancels the scheduling of a scheduled item.
Update ItemUpdates an item.
Reschedule ItemChanges the scheduled publish date of a scheduled item.
Bulk Publish ItemsPublishes multiple items in a single call.

Item Variants

MethodDescription
List VariantsRetrieves a list of up to 500 item variants.
Create VariantCreates an item variant.
Get VariantRetrieves an item variant by ID.
Delete VariantPermanently deletes an item variant.
Update VariantUpdates an item variant.
Bulk Create VariantsCreates multiple item variants.
Bulk Update VariantsUpdates multiple item variants.
Query VariantsRetrieves a list of item variants given the provided paging, filtering, and sorting
Count VariantsRetrieves the number of item variants that match a specified filter.
Bulk Delete VariantsDeletes multiple item variants at once.

Market Listing

MethodDescription
Search Market ListingsSearches published market listings by keyword or app name.

Marketing Activity V1

MethodDescription
Get Marketing ActivityRetrieves a marketing activity by ID.
Create Marketing ActivityCreates a marketing activity.
Query Marketing ActivitiesRetrieves marketing activities matching the given filter.
Update Marketing ActivityUpdates a marketing activity.

Marketing Plan V1

MethodDescription
Generate Marketing PlanGenerates a marketing plan for the site.
Regenerate Marketing PlanRegenerates the upcoming activities of the existing marketing plan
Regenerate Marketing Plan With Keyword ResearchRegenerates the existing marketing plan's activities and runs fresh SEO keyword research to add blog activities.
Get Social Marketing PlanRetrieves the marketing plan's current status and its activities for the requested timeframe.
Delete Marketing PlanDeletes the marketing plan and all its activities.
Clear Marketing Activity PostsRemoves all social posts from a marketing activity.
Regenerate Marketing Activity PostsRegenerates the social post drafts (AI image and per-channel captions) for a marketing activity.
Regenerate Marketing Activity Posts MediaRegenerates only the image for a marketing activity's posts, leaving captions unchanged.
Update Marketing Activity Posts MediaUpdates the media on a marketing activity's posts with the provided media URL
Get Marketing Activity PostsRetrieves the social post drafts and video candidates for the given marketing activities.
Generate Social PostsGenerates social post drafts (AI image and per-channel captions) for the given marketing activities.
Schedule DraftsSchedules the given draft posts for publishing via the Publisher.
Delete Plan Marketing ActivityDeletes a marketing activity from the plan.

Marketing Settings V1

MethodDescription
Get Marketing SettingsRetrieves the site's marketing settings.
Upsert Marketing SettingsCreates or updates the site's marketing settings.
Get Calendar OptionsRetrieves the list of calendar options a site can select when configuring marketing settings.
Get Plan Goal OptionsRetrieves the list of plan goal options a site can choose from when configuring marketing settings.
Get Point Of View OptionsRetrieves the list of point-of-view options a site can choose from when configuring marketing settings.
Get Marketing Settings DefaultsRetrieves the default marketing settings applied when a site hasn't configured its own preferences

Marketplace Provider Service Plugin

MethodDescription
Bulk Add Products To StoreRetrieves full product details from the marketplace provider and adds them to the site owner's Wix Stores catalog.
Bulk Generate MockupsGenerates product mockup images showing the site owner's logo or custom image on the provider's products.
Get InventoryRetrieves current inventory levels for a product's variants.
Get Pricing BreakdownRetrieves pricing breakdown for a product from the marketplace provider.

Marketplace Provider Submissions

MethodDescription
Submit Generated MockupsSubmits generated mockup images for one or more products.

Member Authentication

MethodDescription
Send Set Password EmailSends a site member an email with a link to set or reset their password.

Memberships Service Plugin

MethodDescription
Charge MembershipThis method requests that a membership be charged by your app.
Get Membership VoidabilityThis method retrieves from your app whether a membership can be voided.
Void Membership ChargeThis method requests that a membership charge be voided by your app.
MethodDescription
Duplicate Menu
List MenusRetrieves a list of up to 500 menus.
Create MenuCreates a menu.
Bulk Create MenusCreates multiple menus at once.
Get MenuRetrieves a menu by ID.
Delete MenuDeletes a menu.
Query MenusRetrieves a list of menus given the provided paging, filtering, and sorting
Update MenuUpdates a menu.
Bulk Update MenuUpdates multiple menus at once.
Update Extended FieldsUpdates only the extendedFields field.

Messages

MethodDescription
Create Message StreamCreates a message and streams the assistant's response back in real time.
Media Attachment Upload UrlAllows site visitor to create upload url to use for uploading a file.
Bulk Get By Inbox MessagesRetrieves messages by inbox conversation ID.

Operations

MethodDescription
Get OperationRetrieves an operation.
Update OperationUpdates an operation.
Query OperationRetrieves a list of operations, given the provided paging, filtering, and sorting.
List OperationsRetrieves a list of operations
Calculate First Available Time Slot Per Fulfillment TypeRetrieves the first available time slot of each fulfillment type for a specified operation.
Calculate First Available Time Slots Per OperationRetrieves the first available time slot of each fulfillment type for each specified operation.
Calculate First Available Time Slots Per MenuRetrieves the first available time slot of each fulfillment type for each specified menu.
Calculate Available Time Slots For DateRetrieves all available time slots of each fulfillment type for the specified date.
Calculate Available Dates In RangeRetrieves all available dates of each fulfillment type within the specified time range.
Validate Operation AddressValidates an operation's address.
Bulk Update Operation TagsSynchronously update tags on multiple operations
Bulk Update Operation Tags By FilterAsynchronously update tags on multiple operations according to the specified filter

Order Billing

MethodDescription
Redeem Gift CardRedeems a gift card as payment for an order by applying the gift card balance to the order total.
Generate ReceiptsGenerates digital receipts for an order's completed payments.

Order Payment Requests

MethodDescription
Create Order Payment RequestCreates an order payment request.
Get Order Payment RequestRetrieves an order payment request.
Delete Order Payment RequestDeletes an order payment request.
Update Order Payment RequestUpdates an order payment request.
Query Order Payment RequestsRetrieves a list of up to 1,000 order payment requests, given the provided paging, filtering, and sorting.
Get Order Payment Request URLRetrieves the payment page URL for an order payment request.
Update Extended FieldsUpdates the extended fields of an order payment request.
Void Order Payment RequestVoids the given order payment request.

Orders

MethodDescription
Import OrderImports a single order together with its historical data, such as the original creation date, order number, and statuses.
Set Order Number CounterSets the starting number for orders created after a migration.
Bulk Delete Imported OrdersDeletes multiple imported orders.

Orders Settings

MethodDescription
Get Orders SettingsRetrieves the site's order settings.
Update Orders SettingsUpdates the site's orders settings.

Partner Profile V1

MethodDescription
Find Public Partner Profile By SlugRetrieves the verified, published profile of a partner by their URL slug.
Contact PartnerReserved for Wix first-party client UI use
Create Partner ProfileCreates a partner profile.
Delete Partner ProfileDeletes the partner profile of the currently authenticated partner
Update Partner ProfileUpdates a partner profile.
Get Current Partner ProfileRetrieves the partner profile of the currently authenticated partner.

Payment Settings Integration Service Plugin

MethodDescription
Get Payment SettingsThis method retrieves payment settings from your app.

Pipelines

MethodDescription
Create PipelineCreates a pipeline with defined stages and a final stage.
Get PipelineRetrieves a pipeline by ID.
Delete PipelineDeletes a pipeline.
Update PipelineUpdates a pipeline.
Query PipelinesRetrieves a list of up to 100 pipelines, given the provided paging, filtering, and sorting.
Bulk Update Pipeline TagsUpdates tags on multiple pipelines by specified pipeline IDs.
Bulk Update Pipeline Tags By FilterUpdates tags on multiple pipelines, using a filter to select which pipelines to update.

Premium Feature V1

MethodDescription
Get Feature DataRetrieves the availability and usage quota for a premium feature on the site.
Get Features DataRetrieves the availability and usage quota for multiple premium features on the site.

Pricing Integration Service Plugin

MethodDescription
Calculate PriceThe Custom Pricing extension lets site owners add custom pricing to bookings on the site

Products

MethodDescription
Create ProductCreates a product in the Marketplace.
Get ProductRetrieves a product by ID.
Delete ProductDeletes a product permanently from the Marketplace.
Update ProductUpdates a product
Bulk Create ProductsCreates multiple products in a single request.
Bulk Update ProductsUpdates multiple products in a single request.
Bulk Delete ProductsDeletes multiple products permanently in a single request
Query ProductsRetrieves a list of products with filtering, sorting, and cursor-based pagination.
Search ProductsRetrieves a list of products, given the provided filtering, search expression, sorting, and cursor paging.
Bulk Update Product TagsUpdates tags on multiple products by product IDs.
Bulk Update Product Tags By FilterUpdates tags on multiple products matching a filter.
Query CategoriesQueries categories using WQL - Wix Query Language.
Bulk Add Products To StoreAdds multiple Marketplace products to the caller's Wix store in a single request.

Provisioning V1

MethodDescription
Provision Meetings AppSets up Wix Meetings infrastructure on a site.

Refunds

MethodDescription
Refund TransactionThis endpoint is used to send a merchant's refund requests to a Payment Service Provider (PSP).

Rules

MethodDescription
List RulesRetrieves an array of all rules.
Create RuleCreates a rule.
Get RuleRetrieves a rule.
Delete RuleDeletes a rule.
Update RuleUpdates a rule.
Query RulesRetrieves a list of rules, given the provided paging, filtering, and sorting.
Bulk Create RulesBulk creates rules.
Bulk Update RulesBulk updates rules.
Bulk Delete RulesBulk deletes rules.
Bulk Update Rule TagsSynchronously update tags on multiple rules
Bulk Update Rule Tags By FilterAsynchronously update tags on multiple rules according to the specified filter
Calculate Service FeesCalculates service fees for an order.

Sections

MethodDescription
Duplicate SectionDuplicates a section.
List SectionsRetrieves a list of up to 500 sections.
Create SectionCreates a section.
Bulk Create SectionsCreates multiple sections at once.
Get SectionRetrieves a section by ID.
Delete SectionDeletes a section.
Query SectionsRetrieves a list of sections given the provided paging, filtering, and sorting
Update SectionUpdates a section.
Bulk Update SectionUpdates multiple sections at once.
Bulk Delete SectionsDeletes multiple sections at once.

Site Payment Method Types

MethodDescription
Get Site Payment Method TypeRetrieves a payment method type, with some fields localized according to the caller's language and country.
List Site Payment Method TypesRetrieves a list of payment method types.

Staff Member Settings

MethodDescription
Get Staff Member SettingsRetrieves the current privacy settings for staff member contact information.
Update Staff Member SettingsUpdates privacy settings for staff member contact information.

Staff Sorting Service Plugin

MethodDescription
Sort Staff MembersSorts staff members using custom business logic for assigning resources to a booking.

Storage Item

MethodDescription
Create Storage ItemCreates a storage item.
Get Storage ItemRetrieves the specified storage item.
Update Storage Item ValueUpdates the value of an existing storage item.
Update Storage Item Counter ByAtomically increments or decrements a storage item of type COUNTER by the specified value.
Query Storage ItemsRetrieves a list of storage items based on the filtering, sorting, and paging preferences you provide.
Bulk Update Storage Item TagsUpdates tags for the specified storage items.
Bulk Update Storage Item Tags By FilterUpdates tags for storage items that match the specified filter criteria

Suppliers

MethodDescription
Create SupplierCreates a supplier profile.
Get SupplierRetrieves a supplier by ID, returning complete supplier information including current revision number for update operations.
Delete SupplierPermanently deletes a supplier from the marketplace
Update SupplierUpdates a supplier.
Query SuppliersRetrieves a list of suppliers with filtering, sorting, and cursor-based pagination.
Bulk Create SuppliersCreates multiple suppliers in a single synchronous request.
Bulk Update SuppliersUpdates multiple suppliers in a single synchronous request.
Bulk Delete SuppliersPermanently deletes multiple suppliers in a single synchronous request
Bulk Update Supplier TagsUpdates tags on multiple suppliers specified by supplier IDs in a single synchronous request.
Bulk Update Supplier Tags By FilterUpdates tags on multiple suppliers matching filter criteria in a single asynchronous request.

Tax Settings

MethodDescription
Get Tax SettingsRetrieves the site's tax settings.
Upsert Tax SettingsCreates or updates the site's tax settings.

Template V1

MethodDescription
Copy Site As TemplateCreates a template by duplicating an existing site.
Create Site From TemplateCreates a site from a template.
Publish TemplatePublishes a template, turning it into a public template.
Get TemplateRetrieves a template by ID.
Delete TemplateDeletes a template.
Update TemplateUpdates a template.
Count TemplatesCounts the templates that match the provided filter.
Query TemplatesRetrieves a list of templates, given the provided paging, filtering, and sorting.

Time Slots V2

MethodDescription
List Availability Time Slot End OptionsRetrieves the available end times for a selected start time of an appointment-based service configured with a duration range.

Transactions

MethodDescription
Create TransactionThis endpoint is used to send a merchant's payment requests to a Payment Service Provider (PSP).
Capture TransactionThis endpoint is used to send requests to capture transactions to a Payment Service Provider (PSP).
Void TransactionThis endpoint is used to send requests to void transactions to a Payment Service Provider (PSP).
Query Gift Card TransactionsRetrieves the transaction history for a specific gift card with filtering, sorting, and paging options.

Translation Content

MethodDescription
Get Content Word CountGets word counts and field counts for translatable content across a site.

Trigger Catalog

MethodDescription
Create TriggerCreates a trigger for the specified app
Get TriggerRetrieves a trigger by ID (changes per component version)
Update TriggerUpdates the specified trigger for the specified app.
Delete Trigger By App Id And KeyDeletes a trigger from the specified app.
Query TriggersRetrieves a list of triggers, given the provided paging, filtering, and sorting.
Get Trigger Dynamic SchemaRetrieves a trigger's payload schema with the user's filter field selections applied.
Get Identities SchemaRetrieves the schema of the identity types that triggers can reference.

Triggered Events

MethodDescription
Run AutomationRuns an automation directly, without reporting an event.
Test AutomationRuns an automation in test mode, without reporting an event.
Rerun ActivationReruns a previous activation, reusing its original payload and external entity ID.
Report Action Invocation CompletedReports to Wix that your action has completed.

Verification

MethodDescription
Verify During AuthenticationContinues the registration process when a member is required to verify an email address using a verification code received by email.

Waitlist

MethodDescription
List Waitlisted EntitiesReturns a list of waitlisted entries
Register To WaitlistRegisters a site member to a waitlist
Leave WaitlistRemoves a site member's registration to a waitlist (and cancels the associated pending-state booking)
Book From WaitlistBooks a site member into the session for which they are waitlisted (waiting resource), and the associated booking is checked out

Wix Payments Account

MethodDescription
Connect Wix Payments AccountConnects a Wix Payments account to the site.

Last updated: 14 July 2026

Did this help?