Adobe Commerce only.
Learn more.
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.
Attribute | Data Type | Description |
---|---|---|
cart_id |
String! | The unique ID that identifies the customer’s cart |
Output attributes
The RemoveRewardPointsFromCartOutput
object contains the Cart
object.
Attribute | Data Type | Description |
---|---|---|
cart |
Cart! | Describes the contents of the specified shopping cart |
Cart object
Attribute | Data Type | Description |
---|---|---|
applied_coupon |
AppliedCoupon |
Deprecated. Use applied_coupons instead |
applied_coupons |
[AppliedCoupon ] |
An array of AppliedCoupon objects. Each object contains the code text attribute, which specifies the coupon code |
applied_gift_cards |
[AppliedGiftCard ] |
An array of AppliedGiftCard objects. An AppliedGiftCard object contains the code text attribute, which specifies the gift card code. applied_gift_cards is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module |
applied_reward_points |
RewardPointsAmount |
The amount of reward points applied to the cart |
applied_store_credit |
AppliedStoreCredit |
Contains store credit information applied to the cart. applied_store_credit is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module |
available_gift_wrappings |
[GiftWrapping]! | The list of available gift wrapping options for the cart |
available_payment_methods |
[AvailablePaymentMethod] | Available payment methods |
billing_address |
BillingCartAddress | Contains the billing address specified in the customer’s cart |
email |
String | The customer’s email address |
gift_message |
GiftMessage | A gift message added to the cart |
gift_receipt_included |
Boolean! | Indicates if the customer requested a gift receipt for the cart |
gift_wrapping |
GiftWrapping | The selected gift wrapping for the cart |
id |
ID! | The unique ID of the cart |
is_virtual |
Boolean! | Indicates whether the cart contains only virtual products |
items |
[CartItemInterface] | Contains the items in the customer’s cart |
prices |
CartPrices | Contains subtotals and totals |
printed_card_included |
Boolean! | Indicates if the customer requested a printed card for the cart |
selected_payment_method |
SelectedPaymentMethod | Selected payment method |
shipping_addresses |
[ShippingCartAddress]! | Contains one or more shipping addresses |
total_quantity |
Float! | Total Quantity of products in the cart |
Cart query output provides more information about the Cart
object.
Errors
Error | Description |
---|---|
Could not find a cart with ID \"xxxxx\" |
The ID provided in the cart_id field is invalid or the cart does not exist for the customer. |
The cart isn't active |
The cart with the specified cart ID is unavailable, because the items have been purchased and the cart ID becomes inactive. |
Field removeRewardPointsFromCart.cart_id of required type String! was not provided |
The value specified in the removeRewardPointsFromCart.cart_id argument is empty. |