Users

URLs

Fields

A user has a number of properties, represented by fields.

The full list of supported fields is given below (mandatory fields are marked with *).

Note

Any field not listed in the table below will be ignored if occurs in an API request JSON data.

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*
Product 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 an administrator account
N for a non-administrator account
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