Choose a version:

cartGiftCardCodesUpdate

mutation

Updates the gift card codes applied to the cart. Unlike cartGiftCardCodesAdd, which adds codes without replacing existing ones, this mutation sets the gift card codes for the cart. Gift card codes are case-insensitive.

Anchor to Arguments

Arguments

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to giftCardCodesgiftCardCodes •[String!]! required: The case-insensitive gift card codes.

The input must not contain more than 250 values.

Was this section helpful?

Anchor to CartGiftCardCodesUpdatePayload returnsCartGiftCardCodesUpdatePayload returns

Anchor to cartcart •Cart: The updated cart.
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Was this section helpful?

Examples

cartGiftCardCodesUpdate reference

Mutation Reference

mutation cartGiftCardCodesUpdate($cartId: ID!, $giftCardCodes: [String!]!) {

cartGiftCardCodesUpdate(cartId: $cartId, giftCardCodes: $giftCardCodes) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

"cartId": "gid://shopify/<objectName>/10079785100",

"giftCardCodes": [

"<your-giftCardCodes>"

]

}