deleteCartCoupon

Deletes a coupon from a cart.

It receives data from the getCart endpoint exposed by the BigCommerce API

Signature

declare function deleteCartCoupon(
	context: BigcommerceIntegrationContext,
	params: DeleteCouponParameters
): Promise<DeleteCouponResponse>;

Parameters

Name	Required	Type	Description
`context`	Required	`BigcommerceIntegrationContext`
`params`	Required	`DeleteCouponParameters`

Returns

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

Referenced Types

BigcommerceIntegrationContext
DeleteCouponParameters
DeleteCouponResponse

Examples

Deleting a coupon from a cart that matches the id from the query.

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

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