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:

Abandoned Checkout

MethodDescription
Bulk Delete Abandoned CheckoutsDeletes multiple abandoned checkouts.

Accounts

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

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 FeesThis method retrieves additional fees calculated by your app.

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.

Automations V2

MethodDescription
Create AutomationCreates an automation.
Get AutomationRetrieves an automation by ID.
Delete AutomationDeletes the specified automation.
Update AutomationUpdates the specified automation.
Query AutomationsRetrieves a list of automations
Validate AutomationValidates an automation

Badge Assignments

MethodDescription
Create Badge AssignmentAssigns a badge to a member.
Bulk Create Badge AssignmentsAssigns multiple badges to multiple members in a single request.
Query Badge AssignmentsRetrieves a list of badge assignments, given the provided paging, filtering, and sorting.
Delete Badge AssignmentRemoves a badge assignment, removing the badge from the specified member.
Bulk Delete Badge AssignmentsDeletes multiple badge assignments, removing badges from the specified members.
Bulk Update Badge Assignment TagsUpdates tags on multiple badge assignments.
Bulk Update Badge Assignment Tags By FilterUpdates tags on multiple badge assignments asynchronously using filters.

Badges V4

MethodDescription
Create BadgeCreates a badge.
Get BadgeRetrieves a badge by ID.
Delete BadgeDeletes a badge.
Query BadgesRetrieves a list of badges, given the provided paging, filtering, and sorting.
Update BadgeUpdates a badge.
Move BadgeMoves a badge to a specific position in the display order.

Billable Items

MethodDescription
Create Billable ItemCreates a billable item.
Get Billable ItemRetrieves a billable item.
Delete Billable ItemPermanently deletes a billable item.
Update Billable ItemUpdates a billable item.
Query Billable ItemsRetrieves a list of BillableItems, given the provided paging, filtering, and sorting.
Bulk Create Billable ItemsCreate multiple billable items.
Bulk Update Billable ItemsUpdates multiple billable items.
Bulk Delete Billable ItemsDelete multiple billable items.
Bulk Update Billable Item TagsUpdates tags for multiple billable items
Bulk Update Billable Item Tags By FilterUpdates tags on multiple billable items by filter
Search Billable ItemsRetrieves a list of up to 100 billable items, given the specified filtering, search expression, sorting, and cursor paging.

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.
Create Multi Service BookingCreates a multi-service booking and all included single-service bookings simultaneously.
Reschedule Multi Service BookingReschedules a multi-service booking by changing the timing for all or specific single-service bookings in the package.
Get Multi Service Booking AvailabilityChecks if the business can still accommodate an existing multi-service booking and returns overall bookability status, capacity details, and policy violations.
Cancel Multi Service BookingCancels a multi-service booking and all its associated single-service bookings.
Mark Multi Service Booking As PendingUpdates the status for all single-service bookings in a multi-service booking to PENDING.
Confirm Multi Service BookingUpdates the status for all single-service bookings in a multi-service booking to CONFIRMED.
Decline Multi Service BookingUpdates the status for all single-service bookings in a multi-service booking to DECLINED.
Bulk Get Multi Service Booking Allowed ActionsRetrieves information about which actions the customer can perform for up to 50 multi-service bookings.
Get Multi Service BookingRetrieves a multi-service booking and all its associated single-service bookings.
Add Bookings To Multi Service BookingExpands an existing multi-service booking by adding existing single-service bookings to the package.
Remove Bookings From Multi Service BookingRemoves single-service bookings from a multi-service booking and converts them to independent single-service bookings.
Set Booking Submission IdSets a form submission ID for a booking.
Bulk Calculate Allowed ActionsChecks whether you can reschedule or cancel a list of bookings without using force resolution.

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.

Captcha

MethodDescription
AuthorizeAuthorizes a CAPTCHA token.

Categories

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

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.

Custom Field Suggestions

MethodDescription
List Custom Field SuggestionsRetrieves a list of suggestions for both custom fields and existing fields available from the Wix Members Area.
Query Custom Field SuggestionsRetrieves a list of suggestions for both custom fields and existing fields available from the Wix Members Area, given the provided paging, filtering, and sorting.

DNS Propagation

MethodDescription
Get Dns PropagationRetrieves DNS propagation status for a domain.

Data Collections

MethodDescription
Patch Data CollectionUpdates specified properties of a data collection.
Add Data Collection PluginAdds a plugin to a data collection.
Delete Data Collection PluginRemoves a plugin from a data collection.
Patch Data Collection FieldUpdates specified properties in a data collection's fields array.

Data Permissions

MethodDescription
Get PermissionsRetrieves the current permissions for the specified data collection.
Update PermissionsUpdates permissions for the specified data collection.
Add Special PermissionsAdds special permissions to a specific user or role for the specified data collection.
Update Special PermissionsUpdates the special permissions for the specified user or role.
Remove Special PermissionsRemoves special permissions from a specific user or role.
Get My PermissionsRetrieves the current user's permissions for the specified data collection.

Data Sync Jobs

MethodDescription
Create Data Sync JobCreates a recurring data synchronization job with a cron schedule.
Update Data Sync JobUpdates an existing data synchronization job.
Delete Data Sync JobDeletes a data synchronization job.
Get Data Sync JobRetrieves a data synchronization job by ID.
List Data Sync JobsRetrieves a list of data sync jobs for the current site, given the specified paging, filtering, and sorting.

Default Privacy

MethodDescription
Get Default Privacy StatusRetrieves the default privacy status of a site.
Set Default Privacy StatusSets the default privacy status of a site.

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

Dispute History Records

MethodDescription
Get Dispute History RecordRetrieves a dispute history record.
Query Dispute History RecordsRetrieves a list of dispute history records, given the provided paging, filtering, and sorting.
Bulk Update Dispute History Record TagsUpdates tags on multiple dispute history records simultaneously using a list of dispute history record IDs
Bulk Update Dispute History Record Tags By FilterAsynchronously updates tags on multiple dispute history records based on filter criteria

Disputes

MethodDescription
Get DisputeRetrieves a dispute.
Query DisputesRetrieves a list of disputes, given the provided paging, filtering, and sorting.
Accept DisputeAccepts liability for a dispute, indicating the merchant agrees with the customer's claim.
Defend DisputeDefends a dispute by submitting evidence to the payment service provider or bank handling the dispute.
Bulk Update Dispute TagsUpdates tags on multiple disputes simultaneously using a list of dispute IDs
Bulk Update Dispute Tags By FilterAsynchronously updates tags on multiple disputes 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.

Events Settings

MethodDescription
Get Events SettingsRetrieves the current events settings for a site.
Update Events SettingsUpdates Events Settings.

Experiences

MethodDescription
Create ExperienceCreates an experience.
Get ExperienceRetrieves an experience.
Get Experience By SlugRetrieves an experience by slug.
Update ExperienceUpdates an experience.
Query ExperiencesRetrieves a list of experiences using the specified paging, filtering, and sorting.
Search ExperiencesUse this method to search the fields of the experiences on a site for a given expression.
Bulk Update Experience TagsSynchronously updates tags on multiple experiences by experience IDs
Bulk Update Experience Tags By FilterAsynchronously updates tags on multiple experiences using filter criteria

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.

Folders

MethodDescription
Get FolderRetrieves a folder.
Create FolderCreates a folder.
Delete FolderDeletes a folder.
Update Folder DetailsUpdates a folder's details.
Create Collection ReferenceCreates a collection reference to put a data collection into a folder.
Get Collection ReferencesRetrieves all existing collection references for a data collection.
Delete Collection ReferenceDeletes a collection reference.

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

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 Submissions

MethodDescription
Query Intake Form SubmissionsRetrieves a list of intake form submissions, given the provided paging, filtering, and sorting.
Search Intake Form SubmissionsSearches intake form submissions using full-text search across submission content.
List Intake Form Data By ContactsRetrieves intake form data for specified contacts.
Extend Intake Form SubmissionExtends an intake form submission's expiration date.
Cancel Intake Form SubmissionChanges an intake form submission's status to CANCELED.
Exempt Intake Form SubmissionExempts a customer from having to submit an intake form
Delete Intake Form SubmissionDeletes an intake form submission.
Count Submissions By Intake Form IdsCounts intake form submissions by form IDs.

Intake Forms

MethodDescription
Query Intake FormsRetrieves a list of intake forms, with the specified paging, filtering, and sorting.
Delete Intake FormDeletes an intake form.
Update Intake Form Expiration PeriodUpdates the expiration period of a specific intake form.
Create Customer Submission LinkCreates a shareable link for customers to submit an intake form.
Archive Intake FormArchives an intake form, disabling it from accepting new submissions.
Unarchive Intake FormUnarchives an intake form, enabling it to accept new submissions.

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

Likes

MethodDescription
Create LikeCreates a like for blog content.
Get LikeRetrieves a like created by the currently authenticated site visitor or member.
Delete LikeDeletes a like created by the currently authenticated site visitor or member.
Delete Like By Fqdn And Entity IdDeletes a site visitors' or members' like by blog content FQDN and entity ID.
Query LikesRetrieves a list of likes created by the currently authenticated site visitor or member, given the provided paging, filtering, and sorting.

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
List Eligible MembershipsThis method retrieves eligible memberships from your app.
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.

OAuth Apps

MethodDescription
Create OAuth AppCreates a new OAuth app for a Wix Headless client.
Get OAuth AppRetrieves an OAuth app by ID.
Update OAuth AppUpdates an OAuth app.
Query OAuth AppsRetrieves a list of OAuth apps, given the provided paging, filtering, and sorting.

Operations

MethodDescription
List OperationsRetrieves a list of operations
Get OperationRetrieves an operation.
Update OperationUpdates an operation.
Query OperationRetrieves a list of operations, given the provided paging, filtering, and sorting.
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
Generate ReceiptsGenerates digital receipts for an order's completed payments.
Redeem Gift CardRedeems a gift card as payment for an order by applying the gift card balance to the order total.

Orders Settings

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

Payment Settings Integration Service Plugin

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

Pricing Integration Service Plugin

MethodDescription
Calculate PriceThe Custom Pricing extension lets site owners add custom pricing to bookings on the site
MethodDescription
List GalleriesRetrieves a list of galleries.
Create GalleryCreates a new gallery.
Get GalleryGets a gallery by ID.
Delete GalleryDeletes a gallery.
List Gallery ItemsRetrieves a list of media items in a specified gallery.
Create Gallery ItemCreates a media item in a specified gallery.
Get Gallery ItemGets a gallery item by ID.
Delete Gallery ItemDeletes a media item from a gallery.
Update GalleryUpdates a gallery.
Bulk Delete Gallery ItemsDeletes multiple media items from a gallery.
Update Gallery ItemUpdates a media item in a specified gallery.

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.

Refunds

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

Reservation Locations

MethodDescription
Get Reservation LocationRetrieves a reservation location by ID.
Update Reservation LocationUpdates a reservation location
Query Reservation LocationsRetrieves a list of reservation locations given the provided paging, filtering, and sorting
List Reservation LocationsRetrieves a list of up to 100 reservation locations.

Reservations

MethodDescription
List ReservationsRetrieves a list of up to 100 reservations.
Create ReservationCreates a new reservation.
Get ReservationRetrieves a reservation.
Delete ReservationDeletes a reservation
Update ReservationUpdates a reservation.
Create Held ReservationCreates a new temporary reservation and holds it for the customer for 10 minutes.
Reserve ReservationReserves or requests a held reservation.
Cancel ReservationCancels a reservation.
Query ReservationsRetrieves a list of reservations given the provided paging, filtering, and sorting
Search ReservationsUse this method to search the fields of the table reservations on a site for a given expression.
Bulk Archive ReservationsArchives multiple reservations at once.
Bulk Unarchive ReservationsUnarchives multiple reservations at once.

Review Requests

MethodDescription
Create Review RequestCreates a new review request.
Get Review RequestRetrieves a review request.
Delete Review RequestDeletes a review request.
Query Review RequestsRetrieves a list of review requests, give the provided paging, filtering, and sorting.
Count Review RequestsRetrieves the number of review requests that match a specified filter.
Bulk Cancel Review Requests By FilterCancels review requests given specified filters.

Rules

MethodDescription
Calculate Service FeesCalculates service fees for an order.
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

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.

Sending Domains

MethodDescription
Get Sending DomainRetrieves a sending domain by ID.
Query Sending DomainsRetrieves a list of up to 50 sending domains, given the provided paging and filtering.
Authenticate Sending DomainAuthenticates a sending domain by verifying the required DNS records.

Services V2

MethodDescription
Create Add On GroupCreates a new add-on group for a service and updates the service's addOnGroups array.
Delete Add On GroupDeletes an add-on group.
Update Add On GroupUpdates an add-on group.
List Add On Groups By Service IdRetrieves add-on groups for a service with enriched add-on details.
Set Add Ons For GroupSets the add-ons for a specific group, replacing any existing add-ons in the group.

Shipping Rates Integration Service Plugin

MethodDescription
Get Shipping RatesThis method retrieves applicable shipping rates for a delivery from your app.

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.

Tags

MethodDescription
List TagsRetrieves a list of tags.
Create TagCreates a tag.
Get TagRetrieves a tag.
Delete TagDeletes a tag.
Update TagUpdates a tag.

Ticket Reservations

MethodDescription
Create Ticket ReservationCreates a ticket reservation.
Get Ticket ReservationRetrieves a ticket reservation by ID.
Delete Ticket ReservationDeletes a ticket reservation permanently.
Bulk Update Ticket Reservation TagsUpdates tags on multiple ticket reservations.
Bulk Update Ticket Reservation Tags By FilterUpdates tags on multiple ticket reservations asynchronously using filters.
Cancel Ticket ReservationCancels an existing ticket reservation.

Time Slots

MethodDescription
Get Time SlotsReturns a list of time slots at a specified reservation location on a specified date, and their availability for a specified partySize.
Check Time SlotChecks a restaurant's availability to accommodate a reservation for a specified party size in a specified time slot.
Get Scheduled Time SlotsReturns a list of scheduled time slots at a specified reservation location for a specified time range, and their availability for a specified partySize.

Time Slots V2

MethodDescription
List Multi Service Availability Time SlotsRetrieves a list of multi-service time slots that match the provided filters.
Get Multi Service Availability Time SlotRetrieves a multi-service time slot that matches the specified filters.
List Availability Time SlotsRetrieves a list of appointment time slots that match the provided filters.
Get Availability Time SlotRetrieves detailed information about a specific appointment time slot.
List Event Time SlotsRetrieves a list of class session time slots that match the provided filters.
Get Event Time SlotRetrieves detailed information about a specific class session time slot.

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.

Trigger Catalog

MethodDescription
Create TriggerCreates a trigger for the specified app
Update TriggerUpdates the specified trigger for the specified app.
Delete Trigger By App Id And KeyDeletes a trigger from the specified app.
Get Trigger By App Id And KeyRetrieves the specified trigger.
Query TriggersRetrieves a list of triggers, given the provided paging, filtering, and sorting.
Resolve TriggersReturns triggers that are installed on the site and have sufficient maturity.
Get Trigger Dynamic SchemaRetrieves a trigger's payload schema with the user's filter field selections applied.

Triggered Events

MethodDescription
Report Action Invocation CompletedReports to Wix that your action has completed.

Validations Integration Service Plugin

MethodDescription
Get Validation ViolationsThis method retrieves validation violations from your app.

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.
MethodDescription
SearchRetrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
Did this help?