addCartEntry
Method adding a product to the cart in SAP Commerce Cloud.
This method sends a POST request to the addToCart endpoint of the Alokai Middleware. In turn, it exchanges data with the createCartEntry endpoint exposed by the SAP OCC API Cart Entries Controller.
When vsf-sap-token cookie is present in the browser, this method will add a product to the current user's cart. In case there is no cookie, it will add it to 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 addEntryAndGetCart method.
Signature
export declare function addCartEntry<Res extends CartModification = CartModification,
Props extends AddToCartProps = AddToCartProps>(
props: Props,
options?: MethodOptions
): Promise<Res>;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
Returns a representation of a Cart Modification.
Referenced Types
Examples
Adding product to the cart.
import { sdk } from '~/sdk';
const cartModification = await sdk.commerce.addCartEntry({
cartId: '00035084',
entry: {
quantity: 1,
product: { code: '1992695' }
}
});Adding product to the cart and selecting response fields.
import { sdk } from '~/sdk';
const cartModification = await sdk.commerce.addCartEntry({
cartId: '00035084',
entry: {
quantity: 1,
product: { code: '1992695' }
},
fields: 'quantity,entry(product(code))'
});Adding product to the cart and setting deliveryPointOfService.
import { sdk } from '~/sdk';
const cartModification = await sdk.commerce.addCartEntry({
cartId: '00035084',
entry: {
quantity: 1,
product: { code: '1992695' },
deliveryPointOfService: { name: 'ap_warehouse_e' }
},
});