User Group Fields

User Group Fields Overview

User groups in the Venddor API allow you to organize users by roles and permissions. This document provides a comprehensive list of all supported fields for user group objects.

Important: Mandatory fields are marked with a * symbol. Any field not listed in the table below will be ignored if included in an API request.

The following table lists all available fields for user group objects:

Field Name	Description	Available for Methods	Supported Values
usergroup_id	The ID of the user group	GET	integer
type*	The type of the user group	GET, POST, PUT	`A`—admins `C`—customers
status*	The status of the user group	GET, POST, PUT	`A`—active `H`—hidden `D`—disabled
usergroup	The name of the user group	GET, POST, PUT	string
privileges	The privileges of the members of this group. This only applies to administrator groups	GET	array

Example User Group Request

{
  "type": "C",
  "status": "A",
  "usergroup": "Premium Customers"
}

Example Admin Group Request with Privileges

{
  "type": "A",
  "status": "A",
  "usergroup": "Store Managers",
  "privileges": {
    "manage_catalog": "Y",
    "manage_users": "Y",
    "manage_orders": "Y",
    "manage_settings": "N"
  }
}

Tip: Create different user groups with specific privileges to implement a role-based access control system in your store.

API Endpoints for User Groups

GET /usergroups

Retrieves a list of all user groups.

GET /usergroups/{id}

Retrieves details of a specific user group by ID.

POST /usergroups

Creates a new user group with the provided information.

PUT /usergroups/{id}

Updates an existing user group with the provided information.

DELETE /usergroups/{id}

Deletes a user group with the specified ID.

Important: When deleting a user group, make sure that no users are assigned to that group to avoid access issues.

User Group Fields Reference