checkoutShippingAddressUpdate Mutation
Update 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
Arguments
checkoutShippingAddressUpdate.checkoutId
● ID
deprecated scalar miscellaneous
DEPRECATED
Use id
instead.
The ID of the checkout.
checkoutShippingAddressUpdate.id
● ID
scalar miscellaneous
The checkout's ID.
checkoutShippingAddressUpdate.saveAddress
● Boolean
scalar miscellaneous
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 (unreleased)checkoutShippingAddressUpdate.shippingAddress
● AddressInput!
non-null input miscellaneous
The mailing address to where the checkout will be shipped.
checkoutShippingAddressUpdate.token
● UUID
deprecated scalar miscellaneous
DEPRECATED
Use id
instead.
Checkout token.
checkoutShippingAddressUpdate.validationRules
● CheckoutAddressValidationRules
input checkout
The rules for changing validation for received shipping address data.
Type
CheckoutShippingAddressUpdate
object checkout
Update shipping address in the existing checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.