getSite
Fetches site data.
It receives data from the getSite endpoint exposed by the BigCommerce API
Signature
declare function getSite(
context: BigcommerceIntegrationContext,
params?: GetSiteParameters
): Promise<GetSiteResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | BigcommerceIntegrationContext | |
params | Optional | GetSiteParameters |
Returns
Returns a response with the site data including site URLs.
Referenced Types
Examples
Fetching site data
import { sdk } from '~/sdk.config.ts';
const siteData = await sdk.bigcommerce.getSite()Fetching site data.
import { sdk } from '~/sdk.config.ts';
const channel = ...
const siteData = await sdk.bigcommerce.getSite({ channel })