listVariants( )

Developer Preview

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

Note: The Item Variants API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Retrieves a list of up to 500 item variants.

Permissions
Manage Bookings Services and Settings
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function listVariants(
  options: ListVariantsOptions,
): Promise<ListVariantsResponse>;
Method Parameters
optionsListVariantsOptions
Returns
Return Type:Promise<ListVariantsResponse>
JavaScript
import { itemVariants } from "@wix/restaurants";

async function listVariants(options) {
  const response = await itemVariants.listVariants(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?