getStore
Method fetching information about a specific store from Salesforce Commerce Cloud.
This method communicates with the getStore endpoint of the Vue Storefront API Middleware. In turn, it receives data from the Get store endpoint exposed by OCAPI.
Signature
export declare function getStore(
props: StoreGetParams
): Promise<Store>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | StoreGetParams | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
Returns
Returns a representation of a Store.
Referenced Types
StoreGetParamsStore
Examples
Fetching a store by id.
import { sdk } from '~/sdk.config.ts';
const store = await sdk.commerce.getStore({ id: '12345' });