queryStoreVariants( )

Developer Preview

Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.

Syntax

function queryStoreVariants(query: PlatformQuery): Promise<QueryStoreVariantsResponse>

queryStoreVariants Parameters

NAME

TYPE

DESCRIPTION

query

PlatformQuery

Query options.

Returns

Return Type:

Promise<

QueryStoreVariantsResponse

NAME

TYPE

DESCRIPTION

metadata

PlatformPagingMetadata

Details on the paged set of results returned.

variants

Array<

StoreVariant

List of variants based on the specified filters and sorting.

Was this helpful?

queryStoreVariants example

Copy Code

1import { products } from 'wix-stores.v2';
2  
3 async function queryStoreVariants(query, options) {
4   try {
5     const result = await products.queryStoreVariants(query, options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13