updateCustomersStep - Medusa Core Workflows Reference

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

This step updates one or more customers.

Example#

Code
1const data = updateCustomersStep({2  selector: {3    id: "cus_123"4  },5  update: {6    last_name: "Doe"7  }8})

UpdateCustomersStepInputUpdateCustomersStepInput

The data to update one or more customers.

The filters to select the customers to update.

The data to update the customers with.

CustomerDTO[]CustomerDTO[]

idstring

The ID of the customer.

emailstring

The email of the customer.

has_accountboolean

A flag indicating if customer has an account or not.

default_billing_address_idnull | string

The associated default billing address's ID.

default_shipping_address_idnull | string

The associated default shipping address's ID.

company_namenull | string

The company name of the customer.

first_namenull | string

The first name of the customer.

last_namenull | string

The last name of the customer.

The addresses of the customer.

phonenull | string

The phone of the customer.

groupsobject[]

The groups of the customer.

metadataRecord<string, unknown>

Holds custom data in key-value pairs.

created_bynull | string

Who created the customer.

deleted_atnull | string | Date

The deletion date of the customer.

created_atstring | Date

The creation date of the customer.

updated_atstring | Date

The update date of the customer.

Was this page helpful?