POST
/
admin
/
customers
/
{id}
/
customer-groups
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.customer.batchCustomerGroups("cus_123", {
  add: ["cusgroup_123"],
  remove: ["cusgroup_321"]
})
.then(({ customer }) => {
  console.log(customer)
})
{
  "customer": {
    "id": "<string>",
    "has_account": true,
    "groups": [
      {
        "id": "<string>",
        "name": "<string>",
        "customers": [
          {}
        ],
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "email": "jsmith@example.com",
    "default_billing_address_id": "<string>",
    "default_shipping_address_id": "<string>",
    "company_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "addresses": [
      {
        "id": "<string>",
        "address_name": "<string>",
        "is_default_shipping": true,
        "is_default_billing": true,
        "customer_id": "<string>",
        "company": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "country_code": "us",
        "province": "us-ca",
        "postal_code": "<string>",
        "phone": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "phone": "<string>",
    "metadata": {},
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The customer's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the Retrieve Custom Links documentation.

Body

application/json

SUMMARY

Response

200
application/json

OK

The customer's details.