removeCartCoupon
Remove a discount code from the cart.
It uses the updateCart method to remove a discount code from the cart.
Signature
declare function removeCartCoupon(
context: CommercetoolsIntegrationContext,
params: RemoveCartCouponParams,
discountCode: ReferenceInput,
customQuery?: CustomQuery
): Promise<RemoveCartCouponResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | CommercetoolsIntegrationContext | |
params | Required | RemoveCartCouponParams | |
discountCode | Required | ReferenceInput | |
customQuery | Optional | CustomQuery |
Referenced Types
- CommercetoolsIntegrationContext
- RemoveCartCouponParams
- ReferenceInput
- CustomQuery
- RemoveCartCouponResponse
Examples
Removing a coupon from the cart.
const { cart } = await sdk.commerce.removeCartCoupon(
{ id: '6931b5d2-986f-4d2b-8cba-45007a26eb5e', version: '1' },
{ id: 'discount-code-id', typeId: 'discount-code' }
);