@medusajs/core-flows/dist/customer-group/workflows/create-customer-groups.d.ts

Set of workflow definitions for Medusa

import { CustomerGroupDTO, CreateCustomerGroupDTO } from "@medusajs/framework/types";
/**
 * The data to create customer groups.
 */
export type CreateCustomerGroupsWorkflowInput = {
    /**
     * The customer groups to create.
     */
    customersData: CreateCustomerGroupDTO[];
};
/**
 * The created customer groups.
 */
export type CreateCustomerGroupsWorkflowOutput = CustomerGroupDTO[];
export declare const createCustomerGroupsWorkflowId = "create-customer-groups";
/**
 * This workflow creates one or more customer groups. It's used by the
 * [Create Customer Group Admin API Route](https://docs.medusajs.com/api/admin#customer-groups_postcustomergroups).
 *
 * 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.
 *
 * @example
 * const { result } = await createCustomerGroupsWorkflow(container)
 * .run({
 *   input: {
 *     customersData: [
 *       {
 *         name: "VIP"
 *       }
 *     ]
 *   }
 * })
 *
 * @summary
 *
 * Create one or more customer groups.
 */
export declare const createCustomerGroupsWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<CreateCustomerGroupsWorkflowInput, CreateCustomerGroupsWorkflowOutput, []>;
//# sourceMappingURL=create-customer-groups.d.ts.map