Choose a version:

cartPaymentUpdate

mutation

Update the customer's payment method that will be used to checkout.

Anchor to Arguments

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to paymentpayment

•CartPaymentInput!

required

The payment information for the cart that will be used at checkout.

Was this section helpful?

Anchor to CartPaymentUpdatePayload returnsCartPaymentUpdatePayload returns

Anchor to cartcart •Cart: The updated cart.
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Was this section helpful?

Examples

cartPaymentUpdate reference

Mutation Reference

mutation cartPaymentUpdate($cartId: ID!, $payment: CartPaymentInput!) {

cartPaymentUpdate(cartId: $cartId, payment: $payment) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

"cartId": "gid://shopify/<objectName>/10079785100"

}

Variables

{
  "cartId": "gid://shopify/<objectName>/10079785100"
}

Schema

input CartPaymentInput {
  amount: MoneyInput!
  directPaymentMethod: CartDirectPaymentMethodInput
  freePaymentMethod: CartFreePaymentMethodInput
  sourceIdentifier: String
  walletPaymentMethod: CartWalletPaymentMethodInput
}

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}

input CartDirectPaymentMethodInput {
  acceptedSubscriptionTerms: Boolean
  billingAddress: MailingAddressInput!
  cardSource: CartCardSource
  sessionId: String!
}

input CartFreePaymentMethodInput {
  billingAddress: MailingAddressInput!
}

input CartWalletPaymentMethodInput {
  applePayWalletContent: ApplePayWalletContentInput
  shopPayWalletContent: ShopPayWalletContentInput
}