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.
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.
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.
We would appreciate your feedback on the APIs in Developer Preview. Let us know about:
Please contact us with your feedback.
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.
The following methods are currently in developer preview:
| Method | Description |
|---|---|
| Bulk Delete Abandoned Checkouts | Deletes multiple abandoned checkouts. |
| Method | Description |
|---|---|
| Connect Account | This endpoint is used to connect a merchant's Payment Service Provider (PSP) account to a Wix site. |
| Method | Description |
|---|---|
| Validate Configuration | This method is used to validate a Wix user's action configuration. |
| Get Quota Info | This method retrieves quota information for an action. |
| Invoke | Runs your action. |
| Method | Description |
|---|---|
| Create Add On | Creates an add-on. |
| Get Add On | Retrieves an add-on. |
| Delete Add On | Deletes an add-on and removes it from all add-on groups. |
| Update Add On | Updates an existing add-on. |
| Query Add Ons | Retrieves up to 100 add-ons, given the specified filtering, sorting, and paging. |
| Bulk Create Add Ons | Creates multiple add-ons in a single request. |
| Bulk Update Add Ons | Updates multiple add-ons in a single request. |
| Bulk Delete Add Ons | Deletes multiple add-ons in a single request. |
| Method | Description |
|---|---|
| Calculate Additional Fees | This method retrieves additional fees calculated by your app. |
| Method | Description |
|---|---|
| Change Password | Changes the password of a logged-in member |
| Sign On | Authenticates a member without credentials and returns a session token. |
| Logout | Terminates the member's session and clears authentication cookies. |
| Method | Description |
|---|---|
| Create Automation | Creates an automation. |
| Get Automation | Retrieves an automation by ID. |
| Delete Automation | Deletes the specified automation. |
| Update Automation | Updates the specified automation. |
| Query Automations | Retrieves a list of automations |
| Validate Automation | Validates an automation |
| Method | Description |
|---|---|
| Create Badge Assignment | Assigns a badge to a member. |
| Bulk Create Badge Assignments | Assigns multiple badges to multiple members in a single request. |
| Query Badge Assignments | Retrieves a list of badge assignments, given the provided paging, filtering, and sorting. |
| Delete Badge Assignment | Removes a badge assignment, removing the badge from the specified member. |
| Bulk Delete Badge Assignments | Deletes multiple badge assignments, removing badges from the specified members. |
| Bulk Update Badge Assignment Tags | Updates tags on multiple badge assignments. |
| Bulk Update Badge Assignment Tags By Filter | Updates tags on multiple badge assignments asynchronously using filters. |
| Method | Description |
|---|---|
| Create Badge | Creates a badge. |
| Get Badge | Retrieves a badge by ID. |
| Delete Badge | Deletes a badge. |
| Query Badges | Retrieves a list of badges, given the provided paging, filtering, and sorting. |
| Update Badge | Updates a badge. |
| Move Badge | Moves a badge to a specific position in the display order. |
| Method | Description |
|---|---|
| Create Billable Item | Creates a billable item. |
| Get Billable Item | Retrieves a billable item. |
| Delete Billable Item | Permanently deletes a billable item. |
| Update Billable Item | Updates a billable item. |
| Query Billable Items | Retrieves a list of BillableItems, given the provided paging, filtering, and sorting. |
| Bulk Create Billable Items | Create multiple billable items. |
| Bulk Update Billable Items | Updates multiple billable items. |
| Bulk Delete Billable Items | Delete multiple billable items. |
| Bulk Update Billable Item Tags | Updates tags for multiple billable items |
| Bulk Update Billable Item Tags By Filter | Updates tags on multiple billable items by filter |
| Search Billable Items | Retrieves a list of up to 100 billable items, given the specified filtering, search expression, sorting, and cursor paging. |
| Method | Description |
|---|---|
| Cancel Booking Anonymously | Cancels a booking using an anonymous token. |
| Reschedule Booking Anonymously | Reschedules a booking to a new slot using an anonymous token. |
| Get Booking Anonymously | Retrieves a booking and its allowed anonymous actions using an anonymous token. |
| Get Service Anonymously | Retrieves the service associated with a booking using an anonymous token. |
| Get Anonymous Action Token | Generates an anonymous action token for a booking. |
| Create Multi Service Booking | Creates a multi-service booking and all included single-service bookings simultaneously. |
| Reschedule Multi Service Booking | Reschedules a multi-service booking by changing the timing for all or specific single-service bookings in the package. |
| Get Multi Service Booking Availability | Checks if the business can still accommodate an existing multi-service booking and returns overall bookability status, capacity details, and policy violations. |
| Cancel Multi Service Booking | Cancels a multi-service booking and all its associated single-service bookings. |
| Mark Multi Service Booking As Pending | Updates the status for all single-service bookings in a multi-service booking to PENDING. |
| Confirm Multi Service Booking | Updates the status for all single-service bookings in a multi-service booking to CONFIRMED. |
| Decline Multi Service Booking | Updates the status for all single-service bookings in a multi-service booking to DECLINED. |
| Bulk Get Multi Service Booking Allowed Actions | Retrieves information about which actions the customer can perform for up to 50 multi-service bookings. |
| Get Multi Service Booking | Retrieves a multi-service booking and all its associated single-service bookings. |
| Add Bookings To Multi Service Booking | Expands an existing multi-service booking by adding existing single-service bookings to the package. |
| Remove Bookings From Multi Service Booking | Removes single-service bookings from a multi-service booking and converts them to independent single-service bookings. |
| Set Booking Submission Id | Sets a form submission ID for a booking. |
| Bulk Calculate Allowed Actions | Checks whether you can reschedule or cancel a list of bookings without using force resolution. |
| Method | Description |
|---|---|
| List My Bulk Downloads | Lists all bulk downloads available for the user that initiated them |
| Initiate Bulk Download | Initiates a bulk download process. |
| Get Bulk Download | Retrieves a bulk download. |
| Delete Bulk Download | Deletes a bulk download. |
| Method | Description |
|---|---|
| Authorize | Authorizes a CAPTCHA token. |
| Method | Description |
|---|---|
| Create Category | Creates a new category. |
| Get Category | Retrieves a category by ID. |
| Delete Category | Deletes a category. |
| Update Category | Updates a category. |
| Query Category | Retrieves a list of categories, with the specified paging, filtering, and sorting. |
| Method | Description |
|---|---|
| List Triggers | Lists all custom triggers provided by your service plugin integration. |
| Get Eligible Triggers | Retrieves eligible custom discount triggers based on the provided items. |
| Method | Description |
|---|---|
| List Custom Field Suggestions | Retrieves a list of suggestions for both custom fields and existing fields available from the Wix Members Area. |
| Query Custom Field Suggestions | Retrieves a list of suggestions for both custom fields and existing fields available from the Wix Members Area, given the provided paging, filtering, and sorting. |
| Method | Description |
|---|---|
| Get Dns Propagation | Retrieves DNS propagation status for a domain. |
| Method | Description |
|---|---|
| Patch Data Collection | Updates specified properties of a data collection. |
| Add Data Collection Plugin | Adds a plugin to a data collection. |
| Delete Data Collection Plugin | Removes a plugin from a data collection. |
| Patch Data Collection Field | Updates specified properties in a data collection's fields array. |
| Method | Description |
|---|---|
| Get Permissions | Retrieves the current permissions for the specified data collection. |
| Update Permissions | Updates permissions for the specified data collection. |
| Add Special Permissions | Adds special permissions to a specific user or role for the specified data collection. |
| Update Special Permissions | Updates the special permissions for the specified user or role. |
| Remove Special Permissions | Removes special permissions from a specific user or role. |
| Get My Permissions | Retrieves the current user's permissions for the specified data collection. |
| Method | Description |
|---|---|
| Create Data Sync Job | Creates a recurring data synchronization job with a cron schedule. |
| Update Data Sync Job | Updates an existing data synchronization job. |
| Delete Data Sync Job | Deletes a data synchronization job. |
| Get Data Sync Job | Retrieves a data synchronization job by ID. |
| List Data Sync Jobs | Retrieves a list of data sync jobs for the current site, given the specified paging, filtering, and sorting. |
| Method | Description |
|---|---|
| Get Default Privacy Status | Retrieves the default privacy status of a site. |
| Set Default Privacy Status | Sets the default privacy status of a site. |
| Method | Description |
|---|---|
| Create Delivery Profile | Creates a delivery profile. |
| Get Delivery Profile | Retrieves a delivery profile. |
| Delete Delivery Profile | Deletes a delivery profile. |
| Update Delivery Profile | Updates a delivery profile. |
| Query Delivery Profiles | Retrieves a list of up to 100 delivery profiles, given the provided paging, filtering, and sorting. |
| Add Delivery Region | Adds a delivery region to an existing delivery profile. |
| Update Delivery Region | Updates a delivery region. |
| Get Delivery Profile By Delivery Region Id | Retrieves a delivery profile by delivery region ID. |
| Remove Delivery Region | Removes a delivery region from a delivery profile. |
| Add Delivery Carrier | Adds a delivery carrier to a delivery region. |
| Remove Delivery Carrier | Removes a delivery carrier from a delivery region. |
| Update Delivery Carrier | Updates a delivery carrier's settings in a delivery region. |
| List Installed Delivery Carriers | Retrieves a list of all delivery carriers installed on a site. |
| Get Delivery Destination Properties | Retrieves delivery destination properties. |
| List Delivery Carriers | Retrieves delivery carrier settings for a delivery profile. |
| Set Delivery Carrier Active Status | Sets a delivery carrier's active status. |
| Update Extended Fields | Updates extended fields of a delivery profile without incrementing revision. |
| Method | Description |
|---|---|
| Create Dispute Evidence Document | Creates a dispute evidence document for a specific dispute. |
| Get Dispute Evidence Document | Retrieves a dispute evidence document. |
| Delete Dispute Evidence Document | Deletes a dispute evidence document. |
| Query Dispute Evidence Documents | Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting. |
| Bulk Update Dispute Evidence Document Tags | Updates tags on multiple dispute evidence documents by ID. |
| Bulk Update Dispute Evidence Document Tags By Filter | Asynchronously updates tags on multiple dispute evidence documents based on filter criteria |
| Method | Description |
|---|---|
| Get Dispute History Record | Retrieves a dispute history record. |
| Query Dispute History Records | Retrieves a list of dispute history records, given the provided paging, filtering, and sorting. |
| Bulk Update Dispute History Record Tags | Updates tags on multiple dispute history records simultaneously using a list of dispute history record IDs |
| Bulk Update Dispute History Record Tags By Filter | Asynchronously updates tags on multiple dispute history records based on filter criteria |
| Method | Description |
|---|---|
| Get Dispute | Retrieves a dispute. |
| Query Disputes | Retrieves a list of disputes, given the provided paging, filtering, and sorting. |
| Accept Dispute | Accepts liability for a dispute, indicating the merchant agrees with the customer's claim. |
| Defend Dispute | Defends a dispute by submitting evidence to the payment service provider or bank handling the dispute. |
| Bulk Update Dispute Tags | Updates tags on multiple disputes simultaneously using a list of dispute IDs |
| Bulk Update Dispute Tags By Filter | Asynchronously updates tags on multiple disputes based on filter criteria |
| Method | Description |
|---|---|
| Query Email Subscriptions | Retrieves email subscriptions, given the provided paging, filtering, and sorting. |
| Upsert Email Subscription | Updates or creates an email subscription for the requested email. |
| Bulk Upsert Email Subscription | Updates or creates multiple email subscriptions. |
| Generate Unsubscribe Link | Creates an unsubscribe link to be shared with the relevant recipient. |
| Method | Description |
|---|---|
| Get Events Settings | Retrieves the current events settings for a site. |
| Update Events Settings | Updates Events Settings. |
| Method | Description |
|---|---|
| Create Experience | Creates an experience. |
| Get Experience | Retrieves an experience. |
| Get Experience By Slug | Retrieves an experience by slug. |
| Update Experience | Updates an experience. |
| Query Experiences | Retrieves a list of experiences using the specified paging, filtering, and sorting. |
| Search Experiences | Use this method to search the fields of the experiences on a site for a given expression. |
| Bulk Update Experience Tags | Synchronously updates tags on multiple experiences by experience IDs |
| Bulk Update Experience Tags By Filter | Asynchronously updates tags on multiple experiences using filter criteria |
| Method | Description |
|---|---|
| Query Data Items | Retrieves a list of items based on the provided filtering, sorting, and paging preferences. |
| Count Data Items | Counts the number of items in the specified data collection that match the filtering preferences. |
| Aggregate Data Items | Runs an aggregation query on the specified data collection and returns the resulting list of items. |
| Query Distinct Values | Retrieves a list of distinct values for a given field for all items that match the query, without duplicates. |
| Insert Data Items | Adds one or more items to a collection. |
| Update Data Items | Updates one or more items in a collection |
| Remove Data Items | Removes one or more items from a collection |
| Truncate Data Items | Removes all items from a collection. |
| Query Referenced Data Items | Retrieves the items referenced in the specified field of a referring item |
| Insert Data Item References | Inserts one or more item references into a referring field of the specified item. |
| Remove Data Item References | Removes one or more item references from a referring field of the specified item. |
| List Collections | Retrieves a list of data collections and their details. |
| Create Collection | Creates a new data collection. |
| Update Collection | Updates the structure of an existing data collection. |
| Delete Collection | Deletes a data collection. |
| Get Capabilities | Lists the global capabilities the external database supports. |
| Method | Description |
|---|---|
| Get Folder | Retrieves a folder. |
| Create Folder | Creates a folder. |
| Delete Folder | Deletes a folder. |
| Update Folder Details | Updates a folder's details. |
| Create Collection Reference | Creates a collection reference to put a data collection into a folder. |
| Get Collection References | Retrieves all existing collection references for a data collection. |
| Delete Collection Reference | Deletes a collection reference. |
| Method | Description |
|---|---|
| Validate Submission |
| Method | Description |
|---|---|
| List Fulfillment Methods | Retrieves a list of up to 100 fulfillment methods. |
| Create Fulfillment Method | Creates a new fulfillment method. |
| Bulk Create Fulfillment Methods | Create multiple fulfillment methods at once. |
| Get Fulfillment Method | Retrieves a fulfillment method. |
| Delete Fulfillment Method | Deletes a fulfillment method. |
| Update Fulfillment Method | Updates a fulfillment method. |
| Query Fulfillment Methods | Retrieves a list of fulfillment methods given the provided paging, filtering, and sorting |
| List Available Fulfillment Methods For Address | Retrieves a list of up to 100 fulfillment methods available for a given address. |
| Get Aggregated Method Availability | Retrieves the aggregated availability of a list of fulfillment methods. |
| Bulk Update Fulfillment Method Tags | Synchronously update tags on multiple fulfillment methods |
| Bulk Update Fulfillment Method Tags By Filter | Asynchronously update tags on multiple fulfillment methods according to the specified filter |
| Method | Description |
|---|---|
| Get Balance | This method retrieves gift card data from your app |
| Redeem | This method requests that a transaction be created by your app |
| Void | This method requests that a gift card transaction be voided by your app |
| Method | Description |
|---|---|
| Query Intake Form Submissions | Retrieves a list of intake form submissions, given the provided paging, filtering, and sorting. |
| Search Intake Form Submissions | Searches intake form submissions using full-text search across submission content. |
| List Intake Form Data By Contacts | Retrieves intake form data for specified contacts. |
| Extend Intake Form Submission | Extends an intake form submission's expiration date. |
| Cancel Intake Form Submission | Changes an intake form submission's status to CANCELED. |
| Exempt Intake Form Submission | Exempts a customer from having to submit an intake form |
| Delete Intake Form Submission | Deletes an intake form submission. |
| Count Submissions By Intake Form Ids | Counts intake form submissions by form IDs. |
| Method | Description |
|---|---|
| Query Intake Forms | Retrieves a list of intake forms, with the specified paging, filtering, and sorting. |
| Delete Intake Form | Deletes an intake form. |
| Update Intake Form Expiration Period | Updates the expiration period of a specific intake form. |
| Create Customer Submission Link | Creates a shareable link for customers to submit an intake form. |
| Archive Intake Form | Archives an intake form, disabling it from accepting new submissions. |
| Unarchive Intake Form | Unarchives an intake form, enabling it to accept new submissions. |
| Method | Description |
|---|---|
| List Labels | Retrieves a list of up to 500 item labels. |
| Create Label | Creates an item label. |
| Get Label | Retrieves an item label by ID. |
| Delete Label | Deletes an item label. |
| Query Labels | Retrieves a list of item labels given the provided paging, filtering, and sorting |
| Update Label | Updates an item Label. |
| Method | Description |
|---|---|
| List Modifier Groups | Retrieves a list of up to 500 modifier groups. |
| Create Modifier Group | Creates a modifier group. |
| Get Modifier Group | Retrieves a modifier group by the ID. |
| Delete Modifier Group | Deletes a modifier group. |
| Query Modifier Groups | Retrieves a list of modifier groups given the provided paging, filtering, and sorting |
| Count Modifier Groups | Retrieves the number of modifier groups that match a specified filter. |
| Update Modifier Group | Updates a modifier group. |
| Bulk Create Modifier Groups | Creates multiple modifier groups. |
| Bulk Update Modifier Groups | Updates multiple item modifier groups at once |
| Method | Description |
|---|---|
| List Modifiers | Retrieves a list of up to 500 item modifiers. |
| Create Modifier | Creates an item modifier. |
| Get Modifier | Retrieves an item modifier by ID. |
| Delete Modifier | |
| Update Modifier | Updates an item modifier. |
| Bulk Create Modifiers | Creates multiple item modifiers. |
| Bulk Update Modifiers | Updates multiple item modifiers at once |
| Query Modifiers | Retrieves a list of item modifiers given the provided paging, filtering, and sorting |
| Count Modifiers | Retrieves the number of modifiers that match a specified filter. |
| Bulk Delete Modifiers | Deletes multiple item Modifiers at once. |
| Method | Description |
|---|---|
| List Variants | Retrieves a list of up to 500 item variants. |
| Create Variant | Creates an item variant. |
| Get Variant | Retrieves an item variant by ID. |
| Delete Variant | Permanently deletes an item variant. |
| Update Variant | Updates an item variant. |
| Bulk Create Variants | Creates multiple item variants. |
| Bulk Update Variants | Updates multiple item variants. |
| Query Variants | Retrieves a list of item variants given the provided paging, filtering, and sorting |
| Count Variants | Retrieves the number of item variants that match a specified filter. |
| Bulk Delete Variants | Deletes multiple item variants at once. |
| Method | Description |
|---|---|
| Create Like | Creates a like for blog content. |
| Get Like | Retrieves a like created by the currently authenticated site visitor or member. |
| Delete Like | Deletes a like created by the currently authenticated site visitor or member. |
| Delete Like By Fqdn And Entity Id | Deletes a site visitors' or members' like by blog content FQDN and entity ID. |
| Query Likes | Retrieves a list of likes created by the currently authenticated site visitor or member, given the provided paging, filtering, and sorting. |
| Method | Description |
|---|---|
| Send Set Password Email | Sends a site member an email with a link to set or reset their password. |
| Method | Description |
|---|---|
| List Eligible Memberships | This method retrieves eligible memberships from your app. |
| Charge Membership | This method requests that a membership be charged by your app. |
| Get Membership Voidability | This method retrieves from your app whether a membership can be voided. |
| Void Membership Charge | This method requests that a membership charge be voided by your app. |
| Method | Description |
|---|---|
| Duplicate Menu | |
| List Menus | Retrieves a list of up to 500 menus. |
| Create Menu | Creates a menu. |
| Bulk Create Menus | Creates multiple menus at once. |
| Get Menu | Retrieves a menu by ID. |
| Delete Menu | Deletes a menu. |
| Query Menus | Retrieves a list of menus given the provided paging, filtering, and sorting |
| Update Menu | Updates a menu. |
| Bulk Update Menu | Updates multiple menus at once. |
| Update Extended Fields | Updates only the extendedFields field. |
| Method | Description |
|---|---|
| Create OAuth App | Creates a new OAuth app for a Wix Headless client. |
| Get OAuth App | Retrieves an OAuth app by ID. |
| Update OAuth App | Updates an OAuth app. |
| Query OAuth Apps | Retrieves a list of OAuth apps, given the provided paging, filtering, and sorting. |
| Method | Description |
|---|---|
| List Operations | Retrieves a list of operations |
| Get Operation | Retrieves an operation. |
| Update Operation | Updates an operation. |
| Query Operation | Retrieves a list of operations, given the provided paging, filtering, and sorting. |
| Calculate First Available Time Slot Per Fulfillment Type | Retrieves the first available time slot of each fulfillment type for a specified operation. |
| Calculate First Available Time Slots Per Operation | Retrieves the first available time slot of each fulfillment type for each specified operation. |
| Calculate First Available Time Slots Per Menu | Retrieves the first available time slot of each fulfillment type for each specified menu. |
| Calculate Available Time Slots For Date | Retrieves all available time slots of each fulfillment type for the specified date. |
| Calculate Available Dates In Range | Retrieves all available dates of each fulfillment type within the specified time range. |
| Validate Operation Address | Validates an operation's address. |
| Bulk Update Operation Tags | Synchronously update tags on multiple operations |
| Bulk Update Operation Tags By Filter | Asynchronously update tags on multiple operations according to the specified filter |
| Method | Description |
|---|---|
| Generate Receipts | Generates digital receipts for an order's completed payments. |
| Redeem Gift Card | Redeems a gift card as payment for an order by applying the gift card balance to the order total. |
| Method | Description |
|---|---|
| Get Orders Settings | Retrieves the site's order settings. |
| Update Orders Settings | Updates the site's orders settings. |
| Method | Description |
|---|---|
| Get Payment Settings | This method retrieves payment settings from your app. |
| Method | Description |
|---|---|
| Calculate Price | The Custom Pricing extension lets site owners add custom pricing to bookings on the site |
| Method | Description |
|---|---|
| List Galleries | Retrieves a list of galleries. |
| Create Gallery | Creates a new gallery. |
| Get Gallery | Gets a gallery by ID. |
| Delete Gallery | Deletes a gallery. |
| List Gallery Items | Retrieves a list of media items in a specified gallery. |
| Create Gallery Item | Creates a media item in a specified gallery. |
| Get Gallery Item | Gets a gallery item by ID. |
| Delete Gallery Item | Deletes a media item from a gallery. |
| Update Gallery | Updates a gallery. |
| Bulk Delete Gallery Items | Deletes multiple media items from a gallery. |
| Update Gallery Item | Updates a media item in a specified gallery. |
| Method | Description |
|---|---|
| Create Product | Creates a product in the Marketplace. |
| Get Product | Retrieves a product by ID. |
| Delete Product | Deletes a product permanently from the Marketplace. |
| Update Product | Updates a product |
| Bulk Create Products | Creates multiple products in a single request. |
| Bulk Update Products | Updates multiple products in a single request. |
| Bulk Delete Products | Deletes multiple products permanently in a single request |
| Query Products | Retrieves a list of products with filtering, sorting, and cursor-based pagination. |
| Search Products | Retrieves a list of products, given the provided filtering, search expression, sorting, and cursor paging. |
| Bulk Update Product Tags | Updates tags on multiple products by product IDs. |
| Bulk Update Product Tags By Filter | Updates tags on multiple products matching a filter. |
| Query Categories | Queries categories using WQL - Wix Query Language. |
| Method | Description |
|---|---|
| Refund Transaction | This endpoint is used to send a merchant's refund requests to a Payment Service Provider (PSP). |
| Method | Description |
|---|---|
| Get Reservation Location | Retrieves a reservation location by ID. |
| Update Reservation Location | Updates a reservation location |
| Query Reservation Locations | Retrieves a list of reservation locations given the provided paging, filtering, and sorting |
| List Reservation Locations | Retrieves a list of up to 100 reservation locations. |
| Method | Description |
|---|---|
| List Reservations | Retrieves a list of up to 100 reservations. |
| Create Reservation | Creates a new reservation. |
| Get Reservation | Retrieves a reservation. |
| Delete Reservation | Deletes a reservation |
| Update Reservation | Updates a reservation. |
| Create Held Reservation | Creates a new temporary reservation and holds it for the customer for 10 minutes. |
| Reserve Reservation | Reserves or requests a held reservation. |
| Cancel Reservation | Cancels a reservation. |
| Query Reservations | Retrieves a list of reservations given the provided paging, filtering, and sorting |
| Search Reservations | Use this method to search the fields of the table reservations on a site for a given expression. |
| Bulk Archive Reservations | Archives multiple reservations at once. |
| Bulk Unarchive Reservations | Unarchives multiple reservations at once. |
| Method | Description |
|---|---|
| Create Review Request | Creates a new review request. |
| Get Review Request | Retrieves a review request. |
| Delete Review Request | Deletes a review request. |
| Query Review Requests | Retrieves a list of review requests, give the provided paging, filtering, and sorting. |
| Count Review Requests | Retrieves the number of review requests that match a specified filter. |
| Bulk Cancel Review Requests By Filter | Cancels review requests given specified filters. |
| Method | Description |
|---|---|
| Calculate Service Fees | Calculates service fees for an order. |
| List Rules | Retrieves an array of all rules. |
| Create Rule | Creates a rule. |
| Get Rule | Retrieves a rule. |
| Delete Rule | Deletes a rule. |
| Update Rule | Updates a rule. |
| Query Rules | Retrieves a list of rules, given the provided paging, filtering, and sorting. |
| Bulk Create Rules | Bulk creates rules. |
| Bulk Update Rules | Bulk updates rules. |
| Bulk Delete Rules | Bulk deletes rules. |
| Bulk Update Rule Tags | Synchronously update tags on multiple rules |
| Bulk Update Rule Tags By Filter | Asynchronously update tags on multiple rules according to the specified filter |
| Method | Description |
|---|---|
| Duplicate Section | Duplicates a section. |
| List Sections | Retrieves a list of up to 500 sections. |
| Create Section | Creates a section. |
| Bulk Create Sections | Creates multiple sections at once. |
| Get Section | Retrieves a section by ID. |
| Delete Section | Deletes a section. |
| Query Sections | Retrieves a list of sections given the provided paging, filtering, and sorting |
| Update Section | Updates a section. |
| Bulk Update Section | Updates multiple sections at once. |
| Bulk Delete Sections | Deletes multiple sections at once. |
| Method | Description |
|---|---|
| Get Sending Domain | Retrieves a sending domain by ID. |
| Query Sending Domains | Retrieves a list of up to 50 sending domains, given the provided paging and filtering. |
| Authenticate Sending Domain | Authenticates a sending domain by verifying the required DNS records. |
| Method | Description |
|---|---|
| Create Add On Group | Creates a new add-on group for a service and updates the service's addOnGroups array. |
| Delete Add On Group | Deletes an add-on group. |
| Update Add On Group | Updates an add-on group. |
| List Add On Groups By Service Id | Retrieves add-on groups for a service with enriched add-on details. |
| Set Add Ons For Group | Sets the add-ons for a specific group, replacing any existing add-ons in the group. |
| Method | Description |
|---|---|
| Get Shipping Rates | This method retrieves applicable shipping rates for a delivery from your app. |
| Method | Description |
|---|---|
| Get Site Payment Method Type | Retrieves a payment method type, with some fields localized according to the caller's language and country. |
| List Site Payment Method Types | Retrieves a list of payment method types. |
| Method | Description |
|---|---|
| Get Staff Member Settings | Retrieves the current privacy settings for staff member contact information. |
| Update Staff Member Settings | Updates privacy settings for staff member contact information. |
| Method | Description |
|---|---|
| Sort Staff Members | Sorts staff members using custom business logic for assigning resources to a booking. |
| Method | Description |
|---|---|
| Create Storage Item | Creates a storage item. |
| Get Storage Item | Retrieves the specified storage item. |
| Update Storage Item Value | Updates the value of an existing storage item. |
| Update Storage Item Counter By | Atomically increments or decrements a storage item of type COUNTER by the specified value. |
| Query Storage Items | Retrieves a list of storage items based on the filtering, sorting, and paging preferences you provide. |
| Bulk Update Storage Item Tags | Updates tags for the specified storage items. |
| Bulk Update Storage Item Tags By Filter | Updates tags for storage items that match the specified filter criteria |
| Method | Description |
|---|---|
| Create Supplier | Creates a supplier profile. |
| Get Supplier | Retrieves a supplier by ID, returning complete supplier information including current revision number for update operations. |
| Delete Supplier | Permanently deletes a supplier from the marketplace |
| Update Supplier | Updates a supplier. |
| Query Suppliers | Retrieves a list of suppliers with filtering, sorting, and cursor-based pagination. |
| Bulk Create Suppliers | Creates multiple suppliers in a single synchronous request. |
| Bulk Update Suppliers | Updates multiple suppliers in a single synchronous request. |
| Bulk Delete Suppliers | Permanently deletes multiple suppliers in a single synchronous request |
| Bulk Update Supplier Tags | Updates tags on multiple suppliers specified by supplier IDs in a single synchronous request. |
| Bulk Update Supplier Tags By Filter | Updates tags on multiple suppliers matching filter criteria in a single asynchronous request. |
| Method | Description |
|---|---|
| List Tags | Retrieves a list of tags. |
| Create Tag | Creates a tag. |
| Get Tag | Retrieves a tag. |
| Delete Tag | Deletes a tag. |
| Update Tag | Updates a tag. |
| Method | Description |
|---|---|
| Create Ticket Reservation | Creates a ticket reservation. |
| Get Ticket Reservation | Retrieves a ticket reservation by ID. |
| Delete Ticket Reservation | Deletes a ticket reservation permanently. |
| Bulk Update Ticket Reservation Tags | Updates tags on multiple ticket reservations. |
| Bulk Update Ticket Reservation Tags By Filter | Updates tags on multiple ticket reservations asynchronously using filters. |
| Cancel Ticket Reservation | Cancels an existing ticket reservation. |
| Method | Description |
|---|---|
| Get Time Slots | Returns a list of time slots at a specified reservation location on a specified date, and their availability for a specified partySize. |
| Check Time Slot | Checks a restaurant's availability to accommodate a reservation for a specified party size in a specified time slot. |
| Get Scheduled Time Slots | Returns a list of scheduled time slots at a specified reservation location for a specified time range, and their availability for a specified partySize. |
| Method | Description |
|---|---|
| List Multi Service Availability Time Slots | Retrieves a list of multi-service time slots that match the provided filters. |
| Get Multi Service Availability Time Slot | Retrieves a multi-service time slot that matches the specified filters. |
| List Availability Time Slots | Retrieves a list of appointment time slots that match the provided filters. |
| Get Availability Time Slot | Retrieves detailed information about a specific appointment time slot. |
| List Event Time Slots | Retrieves a list of class session time slots that match the provided filters. |
| Get Event Time Slot | Retrieves detailed information about a specific class session time slot. |
| Method | Description |
|---|---|
| Create Transaction | This endpoint is used to send a merchant's payment requests to a Payment Service Provider (PSP). |
| Capture Transaction | This endpoint is used to send requests to capture transactions to a Payment Service Provider (PSP). |
| Void Transaction | This endpoint is used to send requests to void transactions to a Payment Service Provider (PSP). |
| Query Gift Card Transactions | Retrieves the transaction history for a specific gift card with filtering, sorting, and paging options. |
| Method | Description |
|---|---|
| Create Trigger | Creates a trigger for the specified app |
| Update Trigger | Updates the specified trigger for the specified app. |
| Delete Trigger By App Id And Key | Deletes a trigger from the specified app. |
| Get Trigger By App Id And Key | Retrieves the specified trigger. |
| Query Triggers | Retrieves a list of triggers, given the provided paging, filtering, and sorting. |
| Resolve Triggers | Returns triggers that are installed on the site and have sufficient maturity. |
| Get Trigger Dynamic Schema | Retrieves a trigger's payload schema with the user's filter field selections applied. |
| Method | Description |
|---|---|
| Report Action Invocation Completed | Reports to Wix that your action has completed. |
| Method | Description |
|---|---|
| Get Validation Violations | This method retrieves validation violations from your app. |
| Method | Description |
|---|---|
| Verify During Authentication | Continues the registration process when a member is required to verify an email address using a verification code received by email. |
| Method | Description |
|---|---|
| List Waitlisted Entities | Returns a list of waitlisted entries |
| Register To Waitlist | Registers a site member to a waitlist |
| Leave Waitlist | Removes a site member's registration to a waitlist (and cancels the associated pending-state booking) |
| Book From Waitlist | Books a site member into the session for which they are waitlisted (waiting resource), and the associated booking is checked out |
| Method | Description |
|---|---|
| Connect Wix Payments Account | Connects a Wix Payments account to the site. |
| Method | Description |
|---|---|
| Search | Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried. |