Skip to main content

How to Use CustomerGroup APIs

In this document, you’ll learn how to use the customer groups admin APIs to manage customer groups and their associated customers and price lists.

Overview

Using the Admin API you can manage customer groups by creating, retrieving, updating, and deleting them. You can also manage the customers in a customer group.

Using the PriceList API you can specify among the conditions the customer groups that the prices will apply to.

This guide covers how to use these APIs to perform these tasks.


Prerequisites

Medusa Components

It is assumed that you already have a Medusa server installed and set up. If not, you can follow our quickstart guide to get started.

JS Client

This guide includes code snippets to send requests to your Medusa server using Medusa’s JS Client, JavaScript’s Fetch API, or cURL.

If you follow the JS Client code blocks, it’s assumed you already have Medusa’s JS Client installed and have created an instance of the client.

Authenticated Admin User

You must be an authenticated admin user before following along with the steps in the tutorial.

You can learn more about authenticating as an admin user in the API reference.


Create Customer Groups

You can create a customer group by sending a request to the Create Customer Group endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.create({
name: 'VIP'
})
.then(({ customer_group }) => {
console.log(customer_group.id);
});
Copy to Clipboard

This request requires the Copy to Clipboard parameter and optionally accepts the Copy to Clipboard object parameter to be passed in the body. It returns the created customer group.


List Customer Groups

You can get a list of all customer groups by sending a request to the List Customer Groups endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.list()
.then(({ customer_groups, limit, offset, count }) => {
console.log(customer_groups.length);
});
Copy to Clipboard

This request returns an array of customer groups, as well as pagination fields.

You can also pass filters and other selection query parameters to the request. Check out the API reference for more details on available query parameters.


Retrieve a Customer Group

You can retrieve a single customer group by sending a request to the Get a Customer Group endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.retrieve(customerGroupId)
.then(({ customer_group }) => {
console.log(customer_group.id);
});
Copy to Clipboard

This request accepts the ID of the customer group to retrieve as a path parameter. It returns the customer group of that ID.


Update a Customer Group

You can update a customer group’s data by sending a request to the Update Customer Group endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.update(customerGroupId, {
metadata: {
is_seller: true
}
})
.then(({ customer_group }) => {
console.log(customer_group.id);
});
Copy to Clipboard

This request accepts the ID of the customer group as a path parameter, and optionally accepts the Copy to Clipboard or Copy to Clipboard fields as body parameters. It returns the updated customer group.


Delete Customer Group

You can delete a customer group by sending a request to the Delete a Customer Group endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.delete(customerGroupId)
.then(({ id, object, deleted }) => {
console.log(id);
});
Copy to Clipboard

This request accepts the ID of the customer group to delete as a path parameter. It returns the ID of the deleted entity.


Manage Customers

Add Customer to Group

You can add a customer to a group by sending a request to the Customer Group’s Add Customer endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.addCustomers(customerGroupId, {
customer_ids: [
{
id: customerId
}
]
})
.then(({ customer_group }) => {
console.log(customer_group.id);
});
Copy to Clipboard

This request accepts the ID of the customer group as a path parameter. In its body, it accepts a Copy to Clipboard array of objects. Each object in the array must have the Copy to Clipboard property with its value being the ID of the customer you want to add.

List Customers

You can retrieve a list of all customers in a customer group using the List Customers endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.listCustomers(customerGroupId)
.then(({ customers, count, offset, limit }) => {
console.log(customers.length);
});
Copy to Clipboard

This request accepts the ID of the customer group as a path parameter. It returns an array of customers along with pagination fields.

Remove Customers from a Group

Removing customers from a group does not remove them entirely. They’ll still be available in your store.

You can remove customers from a customer group by sending a request to the Remove Customers endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.customerGroups.removeCustomers(customer_group_id, {
customer_ids: [
{
id: customer_id
}
]
})
.then(({ customer_group }) => {
console.log(customer_group.id);
});
Copy to Clipboard

This request accepts as a path parameter the ID of the customer group to remove customers from. In its body, it accepts a Copy to Clipboard array of objects. Each object in the array must have the Copy to Clipboard property with the value being the ID of the customer to remove from the group.

This request returns the customer group.


Use Customer Groups as Conditions in a Price List

When you create or update a price list, you can specify one or more customer groups as conditions for the price list. You can learn how to do that in the PriceList API documentation.


What’s Next