createCustomerGroupsStep - Medusa Core Workflows Reference

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

This step creates one or more customer groups.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createCustomerGroupsStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = createCustomerGroupsStep({8      "name": "Pamela"9    })10  }11)

Input#

CreateCustomerGroupsStepInputCreateCustomerGroupsStepInput
The data to create customer groups.
namestring
The name of the customer group.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.
created_bystringOptional
Who created the customer group. For example, the ID of the user that created the customer group.

Output#

CustomerGroupDTO[]CustomerGroupDTO[]
CustomerGroupDTOCustomerGroupDTO
The customer group details.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break