Merge pull request #3406 from Shopify/2025-10-deliveryAddressReplace

feat(cart): add cartDeliveryAddressesReplace mutation support

Author: kdaviduik

.changeset/delivery-address-replace-mutation.md

@@ -0,0 +1,30 @@
+---
+'@shopify/hydrogen': minor
+---
+
+Add `cartDeliveryAddressesReplaceDefault` to handle the new `cartDeliveryAddressesReplace` Storefront API mutation (2025-10)
+
+This new mutation replaces all delivery addresses on a cart in a single operation.
+
+**Usage via cart handler:**
+```typescript
+const result = await cart.replaceDeliveryAddresses([
+  {
+    address: {
+      deliveryAddress: {
+        address1: '123 Main St',
+        city: 'Anytown',
+        countryCode: 'US'
+      }
+    },
+    selected: true
+  }
+]);
+```
+
+**Usage via CartForm:**
+```tsx
+<CartForm action={CartForm.ACTIONS.DeliveryAddressesReplace}>
+  {/* form inputs */}
+</CartForm>
+```

packages/hydrogen/src/cart/CartForm.test.tsx

@@ -85,6 +85,7 @@ describe('<CartForm />', () => {
       DeliveryAddressesAdd: 'DeliveryAddressesAdd',
       DeliveryAddressesUpdate: 'DeliveryAddressesUpdate',
       DeliveryAddressesRemove: 'DeliveryAddressesRemove',
+      DeliveryAddressesReplace: 'DeliveryAddressesReplace',
       DiscountCodesUpdate: 'DiscountCodesUpdate',
       GiftCardCodesUpdate: 'GiftCardCodesUpdate',
       GiftCardCodesAdd: 'GiftCardCodesAdd',

packages/hydrogen/src/cart/CartForm.tsx

@@ -259,6 +259,20 @@ type CartDeliveryAddressesUpdateRequire = {
   } & OtherFormData;
 };
 
+type CartDeliveryAddressesReplaceProps = {
+  action: 'DeliveryAddressesReplace';
+  inputs?: {
+    addresses: Array<CartSelectableAddressInput>;
+  } & OtherFormData;
+};
+
+type CartDeliveryAddressesReplaceRequire = {
+  action: 'DeliveryAddressesReplace';
+  inputs: {
+    addresses: Array<CartSelectableAddressInput>;
+  } & OtherFormData;
+};
+
 type CartCustomProps = {
   action: `Custom${string}`;
   inputs?: Record<string, unknown>;
@@ -304,6 +318,7 @@ type CartActionInputProps =
   | CartDeliveryAddressesAddProps
   | CartDeliveryAddressesRemoveProps
   | CartDeliveryAddressesUpdateProps
+  | CartDeliveryAddressesReplaceProps
   | CartCustomProps;
 
 export type CartActionInput =
@@ -324,6 +339,7 @@ export type CartActionInput =
   | CartDeliveryAddressesAddRequire
   | CartDeliveryAddressesRemoveRequire
   | CartDeliveryAddressesUpdateRequire
+  | CartDeliveryAddressesReplaceRequire
   | CartCustomRequire;
 
 type CartFormProps = CartActionInputProps & CartFormCommonProps;
@@ -373,6 +389,7 @@ CartForm.ACTIONS = {
   DeliveryAddressesAdd: 'DeliveryAddressesAdd',
   DeliveryAddressesUpdate: 'DeliveryAddressesUpdate',
   DeliveryAddressesRemove: 'DeliveryAddressesRemove',
+  DeliveryAddressesReplace: 'DeliveryAddressesReplace',
 } as const;
 
 function getFormInput(formData: FormData): CartActionInput {

packages/hydrogen/src/cart/createCartHandler.test.ts

@@ -58,6 +58,7 @@ describe('createCartHandler', () => {
     expect(cart).toHaveProperty('addDeliveryAddresses');
     expect(cart).toHaveProperty('removeDeliveryAddresses');
     expect(cart).toHaveProperty('updateDeliveryAddresses');
+    expect(cart).toHaveProperty('replaceDeliveryAddresses');
   });
 
   it('can add custom methods', () => {

packages/hydrogen/src/cart/createCartHandler.ts

@@ -69,6 +69,10 @@ import {
   type CartDeliveryAddressesUpdateFunction,
   cartDeliveryAddressesUpdateDefault,
 } from './queries/cartDeliveryAddressesUpdateDefault';
+import {
+  type CartDeliveryAddressesReplaceFunction,
+  cartDeliveryAddressesReplaceDefault,
+} from './queries/cartDeliveryAddressesReplaceDefault';
 import type {CartBuyerIdentityInput} from '@shopify/hydrogen-react/storefront-api-types';
 
 export type CartHandlerOptions = {
@@ -185,6 +189,32 @@ export type HydrogenCart = {
   updateDeliveryAddresses: ReturnType<
     typeof cartDeliveryAddressesUpdateDefault
   >;
+  /**
+   * Replaces all delivery addresses on the cart.
+   *
+   * This function sends a mutation to the storefront API to replace all delivery addresses on the cart
+   * with the provided addresses. It returns the result of the mutation, including any errors that occurred.
+   *
+   * @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
+   * @returns {CartDeliveryAddressesReplaceFunction} - A function that takes an array of addresses and optional parameters, and returns the result of the API call.
+   *
+   * @example
+   * const result = await cart.replaceDeliveryAddresses([
+   *   {
+   *     address: {
+   *       deliveryAddress: {
+   *         address1: '123 Main St',
+   *         city: 'Anytown',
+   *         countryCode: 'US'
+   *       }
+   *     },
+   *     selected: true
+   *   }
+   * ], { someOptionalParam: 'value' });
+   */
+  replaceDeliveryAddresses: ReturnType<
+    typeof cartDeliveryAddressesReplaceDefault
+  >;
 };
 
 export type HydrogenCartCustom<
@@ -316,6 +346,8 @@ export function createCartHandler<TCustomMethods extends CustomMethodsBase>(
     addDeliveryAddresses: cartDeliveryAddressesAddDefault(mutateOptions),
     removeDeliveryAddresses: cartDeliveryAddressesRemoveDefault(mutateOptions),
     updateDeliveryAddresses: cartDeliveryAddressesUpdateDefault(mutateOptions),
+    replaceDeliveryAddresses:
+      cartDeliveryAddressesReplaceDefault(mutateOptions),
   };
 
   if ('customMethods' in options) {
@@ -414,6 +446,10 @@ export type HydrogenCartForDocs = {
    * Update cart delivery addresses.
    */
   updateDeliveryAddresses?: CartDeliveryAddressesUpdateFunction;
+  /**
+   * Replace all delivery addresses on the cart.
+   */
+  replaceDeliveryAddresses?: CartDeliveryAddressesReplaceFunction;
   /**
    * Updates additional information (attributes) in the cart.
    */

packages/hydrogen/src/cart/queries/cartDeliveryAddressesReplaceDefault.doc.ts

@@ -0,0 +1,35 @@
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'cartDeliveryAddressesReplace',
+  category: 'utilities',
+  subCategory: 'cart',
+  isVisualComponent: false,
+  related: [],
+  description:
+    'Creates a function that accepts an array of [CartSelectableAddressInput](/docs/api/storefront/2025-10/input-objects/CartSelectableAddressInput) to replace all delivery addresses on a cart',
+  type: 'utility',
+  defaultExample: {
+    description:
+      'Replace all delivery addresses on a cart with a new set of addresses',
+    codeblock: {
+      tabs: [
+        {
+          title: 'JavaScript',
+          code: './cartDeliveryAddressesReplaceDefault.example.js',
+          language: 'js',
+        },
+      ],
+      title: 'example',
+    },
+  },
+  definitions: [
+    {
+      title: 'cartDeliveryAddressesReplaceDefault',
+      type: 'CartDeliveryAddressesReplaceDefaultGeneratedType',
+      description: '',
+    },
+  ],
+};
+
+export default data;

packages/hydrogen/src/cart/queries/cartDeliveryAddressesReplaceDefault.example.js

@@ -0,0 +1,29 @@
+import {cartDeliveryAddressesReplaceDefault} from '@shopify/hydrogen';
+
+const replaceDeliveryAddresses = cartDeliveryAddressesReplaceDefault({
+  storefront,
+  getCartId,
+});
+
+const result = await replaceDeliveryAddresses(
+  [
+    {
+      address: {
+        deliveryAddress: {
+          address1: '<your-address1>',
+          address2: '<your-address2>',
+          city: '<your-city>',
+          company: '<your-company>',
+          countryCode: 'AC',
+          firstName: '<your-firstName>',
+          lastName: '<your-lastName>',
+          phone: '<your-phone>',
+          provinceCode: '<your-provinceCode>',
+          zip: '<your-zip>',
+        },
+      },
+      selected: true,
+    },
+  ],
+  {someOptionalParam: 'value'},
+);

packages/hydrogen/src/cart/queries/cartDeliveryAddressesReplaceDefault.test.ts

@@ -0,0 +1,30 @@
+import {describe, it, expect} from 'vitest';
+import {CART_ID, mockCreateStorefrontClient} from '../cart-test-helper';
+import {cartDeliveryAddressesReplaceDefault} from './cartDeliveryAddressesReplaceDefault';
+
+describe('cartDeliveryAddressesReplaceDefault', () => {
+  it('should return a default cart delivery address replace implementation', async () => {
+    const replaceDeliveryAddresses = cartDeliveryAddressesReplaceDefault({
+      storefront: mockCreateStorefrontClient(),
+      getCartId: () => CART_ID,
+    });
+
+    const result = await replaceDeliveryAddresses([]);
+
+    expect(result.cart).toHaveProperty('id', CART_ID);
+  });
+
+  it('can override cartFragment', async () => {
+    const cartFragment = 'cartFragmentOverride';
+    const replaceDeliveryAddresses = cartDeliveryAddressesReplaceDefault({
+      storefront: mockCreateStorefrontClient(),
+      getCartId: () => CART_ID,
+      cartFragment,
+    });
+
+    const result = await replaceDeliveryAddresses([]);
+
+    expect(result.cart).toHaveProperty('id', CART_ID);
+    expect(result.userErrors?.[0]).toContain(cartFragment);
+  });
+});

packages/hydrogen/src/cart/queries/cartDeliveryAddressesReplaceDefault.tsx

@@ -0,0 +1,93 @@
+import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
+import type {CartSelectableAddressInput} from '@shopify/hydrogen-react/storefront-api-types';
+import {
+  CART_WARNING_FRAGMENT,
+  MINIMAL_CART_FRAGMENT,
+  USER_ERROR_FRAGMENT,
+} from './cart-fragments';
+import type {
+  CartOptionalInput,
+  CartQueryData,
+  CartQueryDataReturn,
+  CartQueryOptions,
+} from './cart-types';
+
+export type CartDeliveryAddressesReplaceFunction = (
+  addresses: Array<CartSelectableAddressInput>,
+  optionalParams?: CartOptionalInput,
+) => Promise<CartQueryDataReturn>;
+
+/**
+ * Replaces all delivery addresses on the cart.
+ *
+ * This function sends a mutation to the storefront API to replace all delivery addresses on the cart
+ * with the provided addresses. It returns the result of the mutation, including any errors that occurred.
+ *
+ * @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
+ * @returns {CartDeliveryAddressesReplaceFunction} - A function that takes an array of addresses and optional parameters, and returns the result of the API call.
+ *
+ * @example
+ * const replaceDeliveryAddresses = cartDeliveryAddressesReplaceDefault({ storefront, getCartId });
+ * const result = await replaceDeliveryAddresses([
+ *    {
+ *      address: {
+ *        deliveryAddress: {
+ *          address1: '123 Main St',
+ *          city: 'Anytown',
+ *          countryCode: 'US'
+ *        }
+ *      },
+ *      selected: true
+ *    }
+ *  ], { someOptionalParam: 'value' }
+ * );
+ */
+export function cartDeliveryAddressesReplaceDefault(
+  options: CartQueryOptions,
+): CartDeliveryAddressesReplaceFunction {
+  return async (
+    addresses: Array<CartSelectableAddressInput>,
+    optionalParams,
+  ) => {
+    const {cartDeliveryAddressesReplace, errors} =
+      await options.storefront.mutate<{
+        cartDeliveryAddressesReplace: CartQueryData;
+        errors: StorefrontApiErrors;
+      }>(CART_DELIVERY_ADDRESSES_REPLACE_MUTATION(options.cartFragment), {
+        variables: {
+          cartId: options.getCartId(),
+          addresses,
+          ...optionalParams,
+        },
+      });
+
+    return formatAPIResult(cartDeliveryAddressesReplace, errors);
+  };
+}
+
+//! @see: https://shopify.dev/docs/api/storefront/2025-10/mutations/cartDeliveryAddressesReplace
+export const CART_DELIVERY_ADDRESSES_REPLACE_MUTATION = (
+  cartFragment = MINIMAL_CART_FRAGMENT,
+) => `#graphql
+  mutation cartDeliveryAddressesReplace(
+    $cartId: ID!
+    $addresses: [CartSelectableAddressInput!]!,
+    $country: CountryCode = ZZ
+    $language: LanguageCode
+  ) @inContext(country: $country, language: $language) {
+    cartDeliveryAddressesReplace(addresses: $addresses, cartId: $cartId) {
+      cart {
+        ...CartApiMutation
+      }
+      userErrors {
+        ...CartApiError
+      }
+      warnings {
+        ...CartApiWarning
+      }
+    }
+  }
+  ${cartFragment}
+  ${USER_ERROR_FRAGMENT}
+  ${CART_WARNING_FRAGMENT}
+`;