Edit in GitHubLog an issue
Adobe Commerce only. Learn more

removeGiftCardFromCart mutation

The removeGiftCardFromCart mutation removes a previously-applied gift card from the cart.

Syntax

mutation: removeGiftCardFromCart(input: RemoveGiftCardFromCartInput): RemoveGiftCardFromCartOutput

Reference

The removeGiftCardFromCart reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example removes a gift card from the cart.

Request:

Copied to your clipboard
mutation {
removeGiftCardFromCart(
input: {
cart_id: "lOeLKsVkZ1PEvA8A7EaCvmEAk4JRBR7A"
gift_card_code: "049XDMZ6L81X"
}
) {
cart {
applied_gift_cards {
code
}
}
}
}

Response:

Copied to your clipboard
{
"data": {
"removeGiftCardFromCart": {
"cart": {
"applied_gift_cards": []
}
}
}
}

Errors

ErrorDescription
Could not find a cart with ID \"xxxxx\"
The ID provided in the cart_id field is invalid or the cart does not exist for the customer.
The gift card couldn't be deleted from the quote.
The value provided in the gift_card_code field is invalid or the gift card with that specific ID does not exist in the cart.
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.