checkoutBillingAddressUpdate Mutation

Updates billing address in the existing checkout.

Triggers the following webhook events:

CHECKOUT_UPDATED (async): A checkout was updated.

Applied directives

@webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])

checkoutBillingAddressUpdate(billingAddress: AddressInput!, checkoutId: ID, id: ID, saveAddress: Boolean = true, token: UUID, validationRules: CheckoutAddressValidationRules): CheckoutBillingAddressUpdate

Returns

CheckoutBillingAddressUpdate

Show return type

type CheckoutBillingAddressUpdate {
  checkout: Checkout
  checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
  errors: [CheckoutError!]!
}

Arguments

billingAddress

billingAddress · AddressInput!

The billing address of the checkout.

checkoutId

checkoutId · ID

The ID of the checkout.

id

id · ID

The checkout’s ID.

saveAddress

saveAddress · Boolean

Indicates whether the billing address should be saved to the user’s address book upon checkout completion. If not provided, the default behavior is to save the address.

Added in Saleor 3.21

Default: true.

token

token · UUID

Checkout token.

validationRules

validationRules · CheckoutAddressValidationRules

The rules for changing validation for received billing address data.

Schema: Saleor 3.23.43. Download SDL.