updateCustomerAddressesWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateCustomerAddressesWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates one or more addresses for customers. It's used by the Update Customer Address Admin API Route and the Update Customer Address Store API Route.

This workflow has a hook that allows you to perform custom actions on the updated customer addresses. For example, you can pass under additional_data custom data that allows you to update custom data models linked to the addresses.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around updating customer addresses.

Examples#

Steps#

Input#

Output#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

addressesUpdated#

This hook is executed after the addresses are updated. You can consume this hook to perform custom actions on the updated addresses.

Example

Code
1import { updateCustomerAddressesWorkflow } from "@medusajs/medusa/core-flows"2
3updateCustomerAddressesWorkflow.hooks.addressesUpdated(4  (async ({ addresses, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.