Choose a version:

cartDiscountCodesUpdate

mutation

Updates the discount codes applied to a Cart. This mutation replaces all existing discount codes with the provided list, so pass an empty array to remove all codes. Discount codes are case-insensitive.

After updating, check each CartDiscountCode in the cart's discountCodes field to see whether the code is applicable to the cart's current contents.

Anchor to Arguments

Arguments

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to discountCodesdiscountCodes •[String!]! required: The case-insensitive discount codes that the customer added at checkout.

The input must not contain more than 250 values.

Was this section helpful?

Anchor to CartDiscountCodesUpdatePayload returnsCartDiscountCodesUpdatePayload 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

cartDiscountCodesUpdate reference

Mutation Reference

mutation cartDiscountCodesUpdate($cartId: ID!, $discountCodes: [String!]!) {

cartDiscountCodesUpdate(cartId: $cartId, discountCodes: $discountCodes) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

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

"discountCodes": [

"<your-discountCodes>"

]

}