checkoutShippingAddressUpdate Mutation

Updates shipping address in the existing checkout.

Triggers the following webhook events:

• CHECKOUT_UPDATED (async): A checkout was updated.

Applied directives

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

checkoutShippingAddressUpdate(checkoutId: ID, id: ID, saveAddress: Boolean = true, shippingAddress: AddressInput!, token: UUID, validationRules: CheckoutAddressValidationRules): CheckoutShippingAddressUpdate

Returns

CheckoutShippingAddressUpdate

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

Arguments

checkoutId

checkoutId · ID

The ID of the checkout.

id

id · ID

The checkout’s ID.

saveAddress

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.

Default: true.

shippingAddress

shippingAddress · AddressInput!

The mailing address to where the checkout will be shipped.

token

token · UUID

Checkout token.

validationRules

validationRules · CheckoutAddressValidationRules

The rules for changing validation for received shipping address data.

Schema: Saleor 3.23.43. Download SDL.