applyCouponsToCart mutation

The applyCouponsToCart mutation applies one or more predefined coupon codes to the specified cart. Valid coupon codes are defined in cart price rules.

The type field of the ApplyCouponsToCartInput object must be set to either APPEND or REPLACE. If the value is REPLACE, the mutation removes any coupon codes that were previously applied. If the value is APPEND, the mutation keeps previously-applied coupons.

Syntax

mutation: {applyCouponsToCart(input: ApplyCouponsToCartInput) {ApplyCouponToCartOutput}}

Reference

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

Example usage

The following example applies the coupon codes H2O and CO2 to the cart. For these coupons to be valid, the Affirm Water Bottle (sku: 24-UG06) must be in the cart.

Because the value of the type field is REPLACE, any coupon code previously applied to the cart will be replaced by the specified coupon codes.

Request:

Copy
mutation {
  applyCouponsToCart(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG",
      coupon_codes: ["H20", "CO2"]
      type: REPLACE
    }
  ) {
    cart {
        itemsV2 {
          items {
            product {
              name
            }
            quantity
          }
          total_count
          page_info {
            page_size
            current_page
            total_pages
          }
      }
      applied_coupons {
        code
      }
      prices {
        grand_total{
          value
          currency
        }
      }
    }
  }
}
Copied to your clipboard
mutation {
  applyCouponsToCart(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG",
      coupon_codes: ["H20", "CO2"]
      type: REPLACE
    }
  ) {
    cart {
        itemsV2 {
          items {
            product {
              name
            }
            quantity
          }
          total_count
          page_info {
            page_size
            current_page
            total_pages
          }
      }
      applied_coupons {
        code
      }
      prices {
        grand_total{
          value
          currency
        }
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "applyCouponsToCart": {
      "cart": {
        "itemsV2": {
          "items": [
            {
              "product": {
                "name": "Gold Membership"
              },
              "quantity": 2
            },
            {
              "product": {
                "name": "Strive Shoulder Pack"
              },
              "quantity": 1
            },
            {
              "product": {
                "name": "Affirm Water Bottle "
              },
              "quantity": 1
            }
          ],
          "total_count": 3,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }
        },
        "applied_coupons": [
          {
            "code": "H20"
          },
          {
            "code": "CO2"
          }
        ],
        "prices": {
          "grand_total": {
            "value": 134.08,
            "currency": "USD"
          }
        }
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "applyCouponsToCart": {
      "cart": {
        "itemsV2": {
          "items": [
            {
              "product": {
                "name": "Gold Membership"
              },
              "quantity": 2
            },
            {
              "product": {
                "name": "Strive Shoulder Pack"
              },
              "quantity": 1
            },
            {
              "product": {
                "name": "Affirm Water Bottle "
              },
              "quantity": 1
            }
          ],
          "total_count": 3,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }
        },
        "applied_coupons": [
          {
            "code": "H20"
          },
          {
            "code": "CO2"
          }
        ],
        "prices": {
          "grand_total": {
            "value": 134.08,
            "currency": "USD"
          }
        }
      }
    }
  }
}

Errors

Last updated 7/24/2024

Was this helpful?

Yes

No