You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getStores
Endpoint for fetching available stores. By default, it uses the getStoresDefaultQuery GraphQL query
Signature
export declare function getStores(
context: SetupContext,
params?: GetStoresParams,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<GetStoresResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Optional | GetStoresParams | Custom queries included in the request |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions | Custom options for the response |
Returns
Stores data