User Fields Reference

User Fields Overview

A user in the Venddor API has various properties represented by fields. This document provides a comprehensive list of all supported fields, along with their descriptions, default values, and supported data types.

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.

User Fields

The following table lists all available fields for user objects:

Field Name Description Default Value Supported Values
email* User's e-mail — Valid e-mail address
user_type* User type:
A for Admin
C for Customer		 — A
C
company_id* ID of the store or vendor the user belongs to Default company ID integer
status* User status:
A for Active
D for Disabled
H for Hidden		 A A
D
H
firstname User's first name — string
lastname User's last name — string
company User company 'Your company' string
company_name Same as company — string
is_root If Y, the user is a root administrator,
if N, the user is not a root administrator		 Y for admin
N for customer		 Y
N
user_id User ID. Used only if the "Use email as login" setting is disabled Set automatically integer
user_login User login — string
timestamp Creation timestamp Set automatically Valid timestamp in seconds
password The value of this field is md5 hash of user password. Used only when creating and updating a user — string

Example User Request

{
  "email": "john.doe@example.com",
  "user_type": "C",
  "company_id": 1,
  "status": "A",
  "firstname": "John",
  "lastname": "Doe",
  "company": "Acme Corporation",
  "password": "5f4dcc3b5aa765d61d8327deb882cf99"
}
Security Warning: Never store or transmit passwords in plain text. Always use a secure hashing algorithm (e.g., MD5) to encrypt passwords before sending them to the API.

API Endpoints for Users

GET /users

Retrieves a list of all users.

GET /users/{id}

Retrieves details of a specific user by ID.

POST /users

Creates a new user with the provided information.

PUT /users/{id}

Updates an existing user with the provided information.

DELETE /users/{id}

Deletes a user with the specified ID.

Tip: When creating admin users, set user_type to "A" and adjust the is_root field based on the level of permissions you want to grant.
Copyright © . Venddor Tecnologia S.A. All rights reserved.