Skip to main content

Customer Groups

Get Customer Groups​

The "Get Customer Groups" API allows you to retrieve a list of customer groups. This feature is useful when listing price of product based on the selected customer group, providing users with pricing options and enhancing their purchasing decisions.

  • Endpoint: api/customer/customer_groups

  • Http Method: GET

info

Please note that ENABLE_CUSTOMER_GROUPS configuration must be enabled to utilize this API.

  • Success Response:
KeyTypeDescription
idintegerUnique identifier for the customer group.
namestringName of the customer group in English.
name_arstringName of the customer group in Arabic.
{
    "code": 200,
    "message": "Success",
    "data": [
        {
            "id": 3,
            "name": "Wholesales Customer",
            "name_ar": "Wholesales Customer"
        }
    ],
    "meta": []
}
info

Check the following section to learn more about the Get Customer Groups API Reference