addVoucherAndGetCart

Add voucher to the cart and get the updated cart from SAP Commerce Cloud.

This method exchanges data with two endpoints exposed by the SAP OCC API: doApplyCartVoucher and getCart.

When vsf-sap-token cookie is present in the request, this method will add a voucher 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.

Signature

export declare function addVoucherAndGetCart(
	context: SapccIntegrationContext,
	props: AddVoucherAndGetNewCartVersionProps
): Promise<Cart>;

Parameters

Name	Required	Type	Description
`context`	Required	`SapccIntegrationContext`
`props`	Required	`AddVoucherAndGetNewCartVersionProps`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.

Returns

Returns a representation of a Cart.

Referenced Types

Examples

Adding a voucher to the cart.

import { sdk } from '~/sdk';

const updatedCart = await sdk.commerce.addVoucherAndGetCart({
  cartId: '00035084',
  voucherId: 'WINTER16'
});

Adding a voucher to the cart and selecting response fields.

import { sdk } from '~/sdk';

const updatedCart = await sdk.commerce.addVoucherAndGetCart({
  cartId: '00035084',
  voucherId: 'WINTER16',
  fields: 'guid,entries(quantity,product(code))'
});