Skip to main content

checkoutShippingMethodUpdate Mutation

DEPRECATED

Use checkoutDeliveryMethodUpdate instead.

Updates the shipping method of the checkout.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout shipping method with the external one.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
  • CHECKOUT_UPDATED (async): A checkout was updated.
checkoutShippingMethodUpdate(
  checkoutId: ID
  id: ID
  shippingMethodId: ID
  token: UUID
): CheckoutShippingMethodUpdate @deprecated
Details
type CheckoutShippingMethodUpdate {
  checkout: Checkout
  checkoutErrors: [CheckoutError!]! @deprecated
  errors: [CheckoutError!]!
}

Arguments​

id ● ID​

The checkout's ID.

shippingMethodId ● ID​

Shipping method.

Show deprecatedHide deprecated

checkoutId ● ID​

DEPRECATED

Use id instead.

The ID of the checkout.

token ● UUID​

DEPRECATED

Use id instead.

Checkout token.

Type​

CheckoutShippingMethodUpdate​

Updates the shipping method of the checkout.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout shipping method with the external one.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
  • CHECKOUT_UPDATED (async): A checkout was updated.