Alokai

getStores

Method fetching information about multiple stores from Salesforce Commerce Cloud.

This method communicates with the getStores endpoint of the Vue Storefront API Middleware. In turn, it receives data from the Get multiple stores endpoint exposed by OCAPI.

Signature

export declare function getStores(
	props: StoresGetParams
): Promise<Store[]>;

Parameters

NameRequiredTypeDescription
propsRequiredStoresGetParamsParameter object which can be used with this method. Refer to its type definition to learn about possible properties.

Returns

Returns an of representations of a Store.

Referenced Types

  • StoresGetParams
  • Store

Examples

Fetching stores by ids.

import { sdk } from '~/sdk.config.ts';

const store = await sdk.commerce.getStores({ id: ['12345', '23456'] });

On this page