You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
deleteCart
Method deleting a cart with a given identifier from SAP Commerce Cloud.
This method sends a POST request to the deleteCart endpoint of the Alokai Middleware. In turn, it exchanges data with the removeCart endpoint exposed by the SAP OCC API Carts Controller.
When vsf-sap-token cookie is present in the browser, this method will delete the current user cart. In case there is no cookie, it will delete an anonymous user cart. For logged-in users, make sure to pass cart code as the cartId param. In case of anonymous users, pass cart guid instead.
Signature
export declare function deleteCart<Props extends DeleteCartProps = DeleteCartProps>(
props: Props,
options?: MethodOptions
): Promise<void>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | Props | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
options | Optional | MethodOptions | Options that can be passed to additionally configure the request or customize the logic in a plugin. |
Returns
This method does not return anything.
Referenced Types
Examples
Deleting a cart.
import { sdk } from '~/sdk';
await sdk.commerce.deleteCart({ cartId: '00035084' });