getInventoryVariants( )

Gets inventory variant information based on the specified option choices.

The getInventoryVariants() function returns a Promise that resolves to the specified inventory variant information.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Stores - all permissions
Manage Products
Read Stores - all read permissions
Read Products
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
inventoryIdstringRequired

Inventory item ID.

optionsGetInventoryVariantsOptions
Returns
Return Type:Promise<GetInventoryVariantsResponse>
Did this help?