Anchor to section titled 'undefined'

cartGiftCardCodesRemove
mutation

Removes the gift card codes applied to the cart.

Anchor to section titled 'Arguments'

Arguments

Anchor to appliedGiftCardIds
appliedGiftCardIds
[ID!]!
required

The gift cards to remove.

The input must not contain more than 250 values.

Anchor to cartId
cartId
ID!
required

The ID of the cart.

Was this section helpful?
Anchor to section titled 'CartGiftCardCodesRemovePayload returns'

CartGiftCardCodesRemovePayload returns

Anchor to CartGiftCardCodesRemovePayload.cart
cart
Cart

The updated cart.

Anchor to CartGiftCardCodesRemovePayload.userErrors
userErrors
[CartUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CartGiftCardCodesRemovePayload.warnings
warnings
[CartWarning!]!
non-null

A list of warnings that occurred during the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation cartGiftCardCodesRemove($appliedGiftCardIds: [ID!]!, $cartId: ID!) {
  cartGiftCardCodesRemove(appliedGiftCardIds: $appliedGiftCardIds, cartId: $cartId) {
    cart {
      # Cart fields
    }
    userErrors {
      field
      message
    }
    warnings {
      # CartWarning fields
    }
  }
}
Hide code
Input
Copy
{
  "appliedGiftCardIds": [
    "gid://shopify/<objectName>/10079785100"
  ],
  "cartId": "gid://shopify/<objectName>/10079785100"
}