List Customer Groups

This endpoint allows you to list all the customer groups in your store.

Information

Customer groups segment your customers into smaller, targeted groups rather than a default group. This enables tailored service, better understanding of their needs, and personalized treatment for each group.

Scopes

customers.read- Customers Read Only

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

status

string

optional

success

string

optional

data

array[object (CustomerGroup) {4}]

optional

number

required

The unique identifier assigned to a specific group of customers.

name

string

required

The name or label for a the Customer Group.

conditions

object

required

Conditions for group membership, such as total_sales > 100, determine auto-assignment. For example, customers with sales exceeding 100 are added to the group automatically.

features

object

required

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 2075683582,
      "name": "VIP Customers"
    },
    {
      "id": 2075683583,
      "name": "Golden Customers"
    }
  ],
  "pagination": {
    "count": 2,
    "total": 2,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

🟠401Unauthorized

Request

Request samples

Responses