Choose a version:

cartDeliveryAddressesRemove

mutation

Removes delivery addresses from the cart.

Arguments

Anchor to addressIdsaddressIds •[ID!]!required: A list of delivery addresses by handle to remove from 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 CartDeliveryAddressesRemovePayload returnsCartDeliveryAddressesRemovePayload 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?

Removes a delivery address from a cart
cartDeliveryAddressesRemove reference

Examples

Open in GraphiQL

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

mutation CartDeliveryAddressesRemove($id: ID!, $addressIds: [ID!]!) {

cartDeliveryAddressesRemove(cartId: $id, addressIds: $addressIds) {

userErrors {

message

code

field

}

warnings {

message

code

target

}

cart {

delivery {

addresses {

selected

oneTimeUse

address {

... on CartDeliveryAddress {

firstName

lastName

}

}`,

{

variables: {

"id": "gid://shopify/Cart/c1-8f1f41212a211bb1502fd5e27fa5b413?key=f0c5f2509893edbafaab3de9c160b9a8",

"addressIds": [

"gid://shopify/CartSelectableAddress/delivery-address-1"

]

);

const data = await response.json();

mutation CartDeliveryAddressesRemove($id: ID!, $addressIds: [ID!]!) {
  cartDeliveryAddressesRemove(cartId: $id, addressIds: $addressIds) {
    userErrors {
      message
      code
      field
    }
    warnings {
      message
      code
      target
    }
    cart {
      id
      delivery {
        addresses {
          id
          selected
          oneTimeUse
          address {
            ... on CartDeliveryAddress {
              firstName
              lastName
            }
          }
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation CartDeliveryAddressesRemove($id: ID!, $addressIds: [ID!]!) { cartDeliveryAddressesRemove(cartId: $id, addressIds: $addressIds) { userErrors { message code field } warnings { message code target } cart { id delivery { addresses { id selected oneTimeUse address { ... on CartDeliveryAddress { firstName lastName } } } } } } }",
 "variables": {
    "id": "gid://shopify/Cart/c1-8f1f41212a211bb1502fd5e27fa5b413?key=f0c5f2509893edbafaab3de9c160b9a8",
    "addressIds": [
      "gid://shopify/CartSelectableAddress/delivery-address-1"
    ]
  }
}'

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation CartDeliveryAddressesRemove($id: ID!, $addressIds: [ID!]!) {
    cartDeliveryAddressesRemove(cartId: $id, addressIds: $addressIds) {
      userErrors {
        message
        code
        field
      }
      warnings {
        message
        code
        target
      }
      cart {
        id
        delivery {
          addresses {
            id
            selected
            oneTimeUse
            address {
              ... on CartDeliveryAddress {
                firstName
                lastName
              }
            }
          }
        }
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Cart/c1-8f1f41212a211bb1502fd5e27fa5b413?key=f0c5f2509893edbafaab3de9c160b9a8",
      "addressIds": [
        "gid://shopify/CartSelectableAddress/delivery-address-1"
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation CartDeliveryAddressesRemove($id: ID!, $addressIds: [ID!]!) {
      cartDeliveryAddressesRemove(cartId: $id, addressIds: $addressIds) {
        userErrors {
          message
          code
          field
        }
        warnings {
          message
          code
          target
        }
        cart {
          id
          delivery {
            addresses {
              id
              selected
              oneTimeUse
              address {
                ... on CartDeliveryAddress {
                  firstName
                  lastName
                }
              }
            }
          }
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Cart/c1-8f1f41212a211bb1502fd5e27fa5b413?key=f0c5f2509893edbafaab3de9c160b9a8",
      "addressIds": [
        "gid://shopify/CartSelectableAddress/delivery-address-1"
      ]
    },
  },
});

Input variables

JSON

{

"id": "gid://shopify/Cart/c1-8f1f41212a211bb1502fd5e27fa5b413?key=f0c5f2509893edbafaab3de9c160b9a8",

"addressIds": [

"gid://shopify/CartSelectableAddress/delivery-address-1"

]

}

Response

JSON

{

"cartDeliveryAddressesRemove": {

"userErrors": [],

"warnings": [],

"cart": {

"id": "gid://shopify/Cart/c1-8f1f41212a211bb1502fd5e27fa5b413?key=f0c5f2509893edbafaab3de9c160b9a8",

"delivery": {

"addresses": []

}