cartSelectedDeliveryOptionsUpdate

mutation

Updates the selected delivery option for one or more CartDeliveryGroup objects in a cart. Each delivery group represents items shipping to a specific address and offers multiple delivery options with different costs and methods.

Use this mutation when a customer chooses their preferred shipping method during checkout. The deliveryOptionHandle identifies which CartDeliveryOption to select for each delivery group.

Anchor to Arguments

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to selectedDeliveryOptionsselectedDeliveryOptions

•[CartSelectedDeliveryOptionInput!]!

required

The selected delivery options.

The input must not contain more than 250 values.

Was this section helpful?

Anchor to CartSelectedDeliveryOptionsUpdatePayload returnsCartSelectedDeliveryOptionsUpdatePayload returns

Anchor to cartcart •Cart: The updated cart.
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Was this section helpful?

Examples

cartSelectedDeliveryOptionsUpdate reference

Mutation Reference

mutation cartSelectedDeliveryOptionsUpdate($cartId: ID!, $selectedDeliveryOptions: [CartSelectedDeliveryOptionInput!]!) {

cartSelectedDeliveryOptionsUpdate(cartId: $cartId, selectedDeliveryOptions: $selectedDeliveryOptions) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

"cartId": "gid://shopify/<objectName>/10079785100",

"selectedDeliveryOptions": [

{

"deliveryGroupId": "gid://shopify/<objectName>/10079785100",

"deliveryOptionHandle": "<your-deliveryOptionHandle>"

}

]

}

Variables

{
  "cartId": "gid://shopify/<objectName>/10079785100",
  "selectedDeliveryOptions": [
    {
      "deliveryGroupId": "gid://shopify/<objectName>/10079785100",
      "deliveryOptionHandle": "<your-deliveryOptionHandle>"
    }
  ]
}

Schema

input CartSelectedDeliveryOptionInput {
  deliveryGroupId: ID!
  deliveryOptionHandle: String!
}