removeStoreCreditFromCart mutation | Magento 2 Developer Documentation

The removeStoreCreditFromCart mutation removes store credit previously applied to the specified cart with the applyStoreCreditToCart mutation. Magento restores the customer’s available store credit to its original amount and recalculates all cart totals.

Store credit must be enabled on the store to run this mutation.

Syntax

mutation: {RemoveStoreCreditFromCart(input: RemoveStoreCreditFromCartInput): {RemoveStoreCreditFromCartOutput}}

Example usage

Request:

mutation {
  removeStoreCreditFromCart(
    input: {
      cart_id: "4HHaKzxpKM2ZwD0IcheRfcPNBWS3OvRM"
    }
  ) {
    cart {
      applied_store_credit {
        applied_balance {
          currency
          value
        }
        current_balance {
          currency
          value
        }
      }
      prices {
        grand_total {
          currency
          value
        }
      }
    }
  }
}

Response:

{
  "data": {
    "removeStoreCreditFromCart": {
      "cart": {
        "applied_store_credit": {
          "applied_balance": {
            "currency": "USD",
            "value": 0
          },
          "current_balance": {
            "currency": "USD",
            "value": 10
          }
        },
        "prices": {
          "grand_total": {
            "currency": "USD",
            "value": 34.64
          }
        }
      }
    }
  }
}

Input attributes

The RemoveStoreCreditFromCartInput object must contain the following attributes.

Attribute	Data Type	Description
`cart_id`	String!	The unique ID that identifies the customer’s cart

Output attributes

The RemoveStoreCreditFromCartOutput object returns the Cart object.

Attribute	Data Type	Description
`cart`	Cart!	Describes the contents of the specified shopping cart

Cart object

Attribute	Data Type	Description
`applied_coupon`	`AppliedCoupon`	Deprecated. Use `applied_coupons` instead
`applied_coupons`	[`AppliedCoupon`]	An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code
`applied_gift_cards`	[`AppliedGiftCard`]	An array of `AppliedGiftCard` objects. An `AppliedGiftCard` object contains the `code` text attribute, which specifies the gift card code. `applied_gift_cards` is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module
`applied_store_credit`	`AppliedStoreCredit`	Contains store credit information applied to the cart. `applied_store_credit` is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module
`available_payment_methods`	[AvailablePaymentMethod]	Available payment methods
`billing_address`	BillingCartAddress	Contains the billing address specified in the customer’s cart
`email`	String	The customer’s email address
`id`	ID!	The ID of the cart
`is_virtual`	Boolean!	Indicates whether the cart contains only virtual products
`items`	[CartItemInterface]	Contains the items in the customer’s cart
`prices`	CartPrices	Contains subtotals and totals
`selected_payment_method`	SelectedPaymentMethod	Selected payment method
`shipping_addresses`	[ShippingCartAddress]!	Contains one or more shipping addresses
`total_quantity`	Float!	Total Quantity of products in the cart

Cart query output provides more information about the Cart object.