Skip to main content

checkoutDeliveryMethodUpdate Mutation

Updates the delivery method (shipping method or pick up point) of the checkout. Updates the checkout shipping_address for click and collect delivery for a warehouse address.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery 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.
checkoutDeliveryMethodUpdate(
deliveryMethodId: ID
id: ID
token: UUID
): CheckoutDeliveryMethodUpdate
Details
type CheckoutDeliveryMethodUpdate {
checkout: Checkout
errors: [CheckoutError!]!
}

Arguments

deliveryMethodId ● ID

Delivery Method ID (Warehouse ID or ShippingMethod ID or CheckoutDelivery ID).

DEPRECATED: Usage of ShippingMethod ID is deprecated. Use CheckoutDelivery ID instead.

id ● ID

The checkout's ID.

Show deprecatedHide deprecated

token ● UUID

DEPRECATED

Use id instead.

Checkout token.

Type

CheckoutDeliveryMethodUpdate

Updates the delivery method (shipping method or pick up point) of the checkout. Updates the checkout shipping_address for click and collect delivery for a warehouse address.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery 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.