Get Started
Product
Resources
Tools & SDKs
Framework
Reference

createCustomerGroupsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more customer groups. It's used by the Create Customer Group Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to create customer groups within your custom flows. For example, you can create customer groups to segregate customers by age group or purchase habits.

Source Code

Examples#

Steps#

createCustomerGroupsStep

Workflow Hook

Step conditioned by when

Input#

CreateCustomerGroupsWorkflowInputCreateCustomerGroupsWorkflowInput

The data to create customer groups.

customersDataCreateCustomerGroupDTO[]

The customer groups to create.

Output#

CreateCustomerGroupsWorkflowOutputCreateCustomerGroupsWorkflowOutput

The created customer groups.

idstring

The ID of the customer group.

namestring

The name of the customer group.

customersPartial<CustomerDTO>[]Optional

The customers of the customer group.

metadataRecord<string, unknown>Optional

Holds custom data in key-value pairs.

created_bynull | stringOptional

Who created the customer group.

deleted_atnull | string | DateOptional

The deletion date of the customer group.

created_atstring | DateOptional

The creation date of the customer group.

updated_atstring | DateOptional

The update date of the customer group.

Was this page helpful?