Alokai

getCart

Fetches a cart.

This method sends a POST request to the getCart endpoint of the Vue Storefront API Middleware. In turn, it receives data from the getCart endpoint exposed by the BigCommerce API

Signature

declare function getCart$1(
	props: GetCartParameters,
	options?: MethodOptions
): Promise<GetCartResponse>;

Parameters

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

Returns

Returns a response with the cart object used in storefront cart responses.

Referenced Types

Examples

Fetching a cart that matches the id from the query

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

const cart = await sdk.bigcommerce.getCart({ id: "930a1424-e8e8-4757-b4f6-8de76c8106cb" });

On this page