deleteCart
Deletes a cart by ID.
This method sends a POST request to the deleteCart endpoint of the Vue Storefront API Middleware. In turn, it receives data from the deleteCart endpoint exposed by the BigCommerce API
Signature
declare function deleteCart$1(
props: DeleteCartParameters,
options?: MethodOptions
): Promise<AxiosResponse<null,
any>>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | DeleteCartParameters | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
options | Optional | MethodOptions |
Returns
Returns null
Referenced Types
- DeleteCartParameters
AxiosResponse
Examples
Deleting a cart that matches the id from the query
import { sdk } from '~/sdk.config.ts';
await sdk.bigcommerce.deleteCart({ id: "930a1424-e8e8-4757-b4f6-8de76c8106cb" })