getProductOptionsAvailability( )

Gets the availability of relevant product variants based on the product ID and selections provided. See Use Cases for an example.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getProductOptionsAvailability(
  _id: string,
  options: Record<string, string>,
): Promise<ProductOptionsAvailabilityResponse>;
Method Parameters
_idstringRequired

Requested product ID.

optionsRecord<string, string>Required

Array containing the selected options. For example, ["color": "Blue", "size": "Large"].

Returns
Return Type:Promise<ProductOptionsAvailabilityResponse>
JavaScript
import { products } from "@wix/stores";

async function getProductOptionsAvailability(id, options) {
  const response = await products.getProductOptionsAvailability(id, options);
}
Errors

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

Did this help?