removeCartEntry

Method removing a product from the cart in SAP Commerce Cloud.

This method sends a POST request to the deleteFromCart endpoint of the Alokai Middleware. In turn, it exchanges data with the removeCartEntry endpoint exposed by the SAP OCC API Cart Entries Controller.

When vsf-sap-token cookie is present in the browser, this method will remove a product from the current user's cart. In case there is no cookie, it will remove it from the anonymous user's cart. For logged-in users, make sure to pass cart code as the cartId param. In case of anonymous users, pass cart guid instead.

You might also want to see the removeEntryAndGetCart method.

Signature

export declare function removeCartEntry<Props extends DeleteFromCartProps = DeleteFromCartProps>(
	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

Removing product from the cart.

import { sdk } from '~/sdk';

await sdk.commerce.removeCartEntry({
  cartId: '00035084',
  entryNumber: 1
});