Skip to main content

checkoutShippingAddressUpdate

Update shipping address in the existing checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.
checkoutShippingAddressUpdate(
  checkoutId: ID
  id: ID
  shippingAddress: AddressInput!
  token: UUID
  validationRules: CheckoutAddressValidationRules
): CheckoutShippingAddressUpdate

Arguments​

checkoutShippingAddressUpdate.checkoutId ● ID scalar​

The ID of the checkout.

DEPRECATED: this field will be removed in Saleor 4.0. Use id instead.

checkoutShippingAddressUpdate.id ● ID scalar​

The checkout's ID.

Added in Saleor 3.4

checkoutShippingAddressUpdate.shippingAddress ● AddressInput! non-null input​

The mailing address to where the checkout will be shipped.

checkoutShippingAddressUpdate.token ● UUID scalar​

Checkout token.

DEPRECATED: this field will be removed in Saleor 4.0. Use id instead.

checkoutShippingAddressUpdate.validationRules ● CheckoutAddressValidationRules input​

The rules for changing validation for received shipping address data.

Added in Saleor 3.5

Type​

CheckoutShippingAddressUpdate object​

Update shipping address in the existing checkout.

Triggers the following webhook events:

  • CHECKOUT_UPDATED (async): A checkout was updated.