Choose a version:

cartDeliveryAddressesReplace

mutation

Replaces all delivery addresses on a Cart with a new set of addresses in a single operation. Unlike cartDeliveryAddressesUpdate, which modifies existing addresses, this mutation removes all current addresses and sets the provided list as the new delivery addresses.

One address can be marked as selected, and each address can be flagged for one-time use or configured with a specific validation strategy.

Anchor to Arguments

Arguments

Anchor to addressesaddresses

•[CartSelectableAddressInput!]!

required

A list of delivery addresses to replace on the cart.

The input must not contain more than 250 values.

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Was this section helpful?

Anchor to CartDeliveryAddressesReplacePayload returnsCartDeliveryAddressesReplacePayload 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

cartDeliveryAddressesReplace reference

Mutation Reference

mutation cartDeliveryAddressesReplace($cartId: ID!, $addresses: [CartSelectableAddressInput!]!) {

cartDeliveryAddressesReplace(cartId: $cartId, addresses: $addresses) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

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

"addresses": [

{

"address": {

"deliveryAddress": {},

"copyFromCustomerAddressId": "gid://shopify/<objectName>/10079785100"

"selected": true,

"oneTimeUse": true,

"validationStrategy": "COUNTRY_CODE_ONLY"

}

]

}

Variables

{
  "cartId": "gid://shopify/<objectName>/10079785100",
  "addresses": [
    {
      "address": {
        "deliveryAddress": {},
        "copyFromCustomerAddressId": "gid://shopify/<objectName>/10079785100"
      },
      "selected": true,
      "oneTimeUse": true,
      "validationStrategy": "COUNTRY_CODE_ONLY"
    }
  ]
}

Schema

input CartSelectableAddressInput {
  address: CartAddressInput!
  selected: Boolean
  oneTimeUse: Boolean
  validationStrategy: DeliveryAddressValidationStrategy
}

input CartAddressInput {
  deliveryAddress: CartDeliveryAddressInput
  copyFromCustomerAddressId: ID
}