addCouponToCart

Add coupon to the cart.

This method communicates with the addCouponToCart method of the Vue Storefront API Middleware. In turn, it receives data from the getCart endpoint exposed by the BigCommerce API

Signature

declare function addCouponToCart$1(
	props: AddCouponParameters,
	options?: MethodOptions
): Promise<AddCouponResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`AddCouponParameters`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`options`	Optional	`MethodOptions`	Options available for a method.

Returns

Returns a response with the cart object used in storefront cart responses.

Referenced Types

AddCouponParameters
AddCouponResponse

Examples

Adding a coupon and fetching updated cart:

import { sdk } from '~/sdk.config.ts';

const cart = await sdk.bigcommerce.addCoupon({ checkoutId: "930a1424-e8e8-4757-b4f6-8de76c8106cb", "couponCode": "some-code" });