removeCouponsFromCart mutation

The removeCouponsFromCart mutation removes previously-applied coupons from the cart. The cart must contain at least one item in order to remove coupons.

Syntax

mutation: {removeCouponsFromCart(input: RemoveCouponsFromCartInput) {RemoveCouponFromCartOutput}}

Reference

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

Example usage

The following example removes coupons H2O and CO2 from the cart.

Request:

Copy
mutation {
  removeCouponsFromCart(
    input:
      {
        cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
        coupon_codes: ["H2O", "CO2"]
      }
    ) {
    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 {
  removeCouponsFromCart(
    input:
      {
        cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
        coupon_codes: ["H2O", "CO2"]
      }
    ) {
    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": {
    "removeCouponFromCart": {
      "cart": {
        "itemsV2": {
          "items": [
            {
              "product": {
                "name": "Strive Shoulder Pack"
              },
              "quantity": 1
            },
            {
              "product": {
                "name": "Affirm Water Bottle "
              },
              "quantity": 1
            }
          ],
          "total_count": 2,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }          
        },
        "applied_coupons": null,
        "prices": {
          "grand_total": {
            "value": 39,
            "currency": "USD"
          }
        }
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "removeCouponFromCart": {
      "cart": {
        "itemsV2": {
          "items": [
            {
              "product": {
                "name": "Strive Shoulder Pack"
              },
              "quantity": 1
            },
            {
              "product": {
                "name": "Affirm Water Bottle "
              },
              "quantity": 1
            }
          ],
          "total_count": 2,
          "page_info": {
            "page_size": 20,
            "current_page": 1,
            "total_pages": 1
          }          
        },
        "applied_coupons": null,
        "prices": {
          "grand_total": {
            "value": 39,
            "currency": "USD"
          }
        }
      }
    }
  }
}

Errors

Last updated 3/18/2024

Was this helpful?

Yes

No