Skip to main content
View Markdown

checkoutBillingAddressUpdate Mutation

Updates billing address in the existing checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.
checkoutBillingAddressUpdate(
  billingAddress: AddressInput!
  checkoutId: ID
  id: ID
  saveAddress: Boolean = true
  token: UUID
  validationRules: CheckoutAddressValidationRules
): CheckoutBillingAddressUpdate
Details
type CheckoutBillingAddressUpdate {
  checkout: Checkout
  checkoutErrors: [CheckoutError!]! @deprecated
  errors: [CheckoutError!]!
}

Arguments​

billingAddress ● AddressInput!​

The billing address of the checkout.

id ● ID​

The checkout's ID.

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

validationRules ● CheckoutAddressValidationRules​

The rules for changing validation for received billing address data.

Show deprecatedHide deprecated

checkoutId ● ID​

DEPRECATED

Use id instead.

The ID of the checkout.

token ● UUID​

DEPRECATED

Use id instead.

Checkout token.

Type​

CheckoutBillingAddressUpdate​

Updates billing address in the existing checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.