Skip to content
Last update: March 19, 2024

clearPayments mutation

This mutation removes all payment methods from the cart.

Arguments

The InputClearPaymentsType represents the input object type used for clearing all payments from a cart.

Field Description
cartId String The Id of the cart from which all payments will be cleared.
storeId String! The Id of the store associated with the cart.
cartName String The name of the cart.
userId String The Id of the user who owns the cart.
currencyCode String The currency code for the cart.
cultureName String The culture or language associated with the cart.
cartType String The type of the cart.

Possible returns

Possible return Description
CartType The properties and fields associated with a shopping cart. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
mutation clearPayments($command: InputClearPaymentsType!) {
  clearPayments(command: $command) {
    id
    payments {
      id
      outerId
      amount {
        amount
      }
      billingAddress {
        line1
      }
    }
  }
}

1
2
3
4
5
6
7
8
9
"command": {
  "cartId": "e6a7d5af-6378-44a6-b645-af9ecf702c05",
  "storeId": "B2B-store",
  "cartName": "default",
  "userId": "c50e5237-8a4c-41fe-b878-8e5a72390a08",
  "cultureName": "en-US",
  "currencyCode": "USD",
  "cartType": "cart"
}