Skip to main content
View Markdown

checkoutShippingAddressUpdate Mutation

Updates shipping address in the existing checkout.

Triggers the following webhook events:

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

Arguments​

id ● ID​

The checkout's ID.

saveAddress ● Boolean​

Indicates whether the shipping 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

shippingAddress ● AddressInput!​

The mailing address to where the checkout will be shipped.

validationRules ● CheckoutAddressValidationRules​

The rules for changing validation for received shipping 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​

CheckoutShippingAddressUpdate​

Updates shipping address in the existing checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.