removeRewardPointsFromCart mutation

The removeRewardPointsFromCart mutation removes all reward points that were previously applied to the customer’s cart with the applyRewardPointsToCart mutation.

Syntax

mutation: removeRewardPointsFromCart(cartId: ID!): RemoveRewardPointsFromCartOutput

Example usage

The following example removes all reward points from the customer’s cart. The applied_rewards_points object is now null.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
mutation {
  removeRewardPointsFromCart(cartId: "8k0Q4MpH2IGahWrTRtqM61YV2MtLPApz")
  {
    cart {
      applied_reward_points {
        money {
          currency
          value
        }
        points
      }
      prices {
        applied_taxes {
          amount {
            currency
            value
          }
        }
        grand_total {
          currency
          value
        }
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "data": {
    "removeRewardPointsFromCart": {
      "cart": {
        "applied_reward_points": null,
        "prices": {
          "applied_taxes": [
            {
              "amount": {
                "currency": "USD",
                "value": 6.93
              }
            }
          ],
          "grand_total": {
            "currency": "USD",
            "value": 90.93
          }
        }
      }
    }
  }
}

Input attributes

The removeRewardPointsFromCart mutation requires the cart_id attribute.

Output attributes

The RemoveRewardPointsFromCartOutput object contains the Cart object.

Cart object

Cart query output provides more information about the Cart object.