Alokai

removeCouponFromCart

Remove coupon from cart

Signature

declare function removeCouponFromCart(
	context: Context,
	input: RemoveCouponFromCartInput,
	customQuery?: CustomQuery,
	customHeaders?: CustomHeaders
): Promise<FetchResult<RemoveCouponFromCartMutation>>;

Parameters

NameRequiredTypeDescription
contextRequiredContext
inputRequiredRemoveCouponFromCartInput
customQueryOptionalCustomQuery
customHeadersOptionalCustomHeaders

Referenced Types

Examples

Simple usage:

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

// assuming that the coupon code is already applied to the cart
const params = {
 cart_id: 'test-cart-id',
};

// Remove coupon from cart
const result = await sdk.magento.removeCouponFromCart(params);

Creating a custom GraphQL query for getting cart

module.exports = {
  integrations: {
    magento: {
      customQueries: {
        'remove-coupon-from-cart-custom-query': ({ variables, metadata }) => ({
           variables,
           query: `
             mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
               removeCouponFromCart(input: $input) {
                 ${metadata.fields}
               }
             }`
        }),
      },
    }
  }
};

Using a custom GraphQL query to fetch reduced amount of data

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

 const customQuery = {
   removeCouponFromCart: 'remove-coupon-from-cart-custom-query',
     metadata: {
       fields: 'cart { applied_coupons { code } }'
     }
   };

 // The only required parameter is cart_id
 const params = {
   cart_id: 'test-cart-id',
 };

 // The result will contain only fields configured in the custom query
 const result = await sdk.magento.removeCouponFromCart(params, customQuery);

On this page