applyCouponToCart mutation

The applyCouponToCart mutation applies a predefined coupon code to the specified cart. Valid coupon codes are defined in cart price rules.

Syntax

mutation: {applyCouponToCart(input: ApplyCouponToCartInput) {ApplyCouponToCartOutput}}

Reference

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

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following example applies the coupon code H2O to the cart. For this coupon to be valid, the Affirm Water Bottle (sku: 24-UG06) must be in the cart.

Request:

mutation {
  applyCouponToCart(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG",
      coupon_code: "H20"
    }
  ) {
    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:

{
  "data": {
    "applyCouponToCart": {
      "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"
        },
        "prices": {
          "grand_total": {
            "value": 134.08,
            "currency": "USD"
          }
        }
      }
    }
  }
}

Errors