User

A person, or an app's own user, who signs in to the retailer's iVendNext, with their roles.

Area: Your app: its install, its user and its doors · Why it is here: recipe customer_history_page; recipe integration_user · Fields: 77

iVendNext's own description: Represents a User in the system.

Read and write it

Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.

Read a list (only name unless you ask for fields):

curl -s "https://⟨site⟩/api/resource/User?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one, with its tables:

curl -s "https://⟨site⟩/api/resource/User/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/User" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"email": …, "first_name": …}'

Change one with PUT /api/resource/User/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Samples that use it

s8_estate_rollout · s10_ai_manager · s11_approvals · s14_approvals_stores · s16_pick_route · s22_customer_loyalty · s27_stock_alerts · s28_merge_and_history · s39_pharmacy_counter · s40_expiry_recall · s45_restaurant_back_office

Fields

Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Enabled	`enabled`	Check		yes
Email	`email`	Data	yes
First Name	`first_name`	Data	yes
Middle Name	`middle_name`	Data
Last Name	`last_name`	Data
Full Name	`full_name`	Data		yes
Username	`username`	Data
Language	`language`	Link				Language
Time Zone	`time_zone`	Autocomplete
Retail Permission (added by iVendNext)	`custom_retail_permission`	Link				Retail Permission
Is POS User (added by iVendNext)	`custom_is_cashier`	Check
Is Desk User (added by iVendNext)	`custom_is_desk_user`	Check
Send Welcome Email	`send_welcome_email`	Check
Unsubscribed	`unsubscribed`	Check			yes
User Image	`user_image`	Attach Image			yes
Role Profile	`role_profile_name`	Link				Role Profile
Roles Assigned	`roles`	Table		yes	yes	Has Role
Module Profile	`module_profile`	Link				Module Profile
Block Modules	`block_modules`	Table			yes	Block Module
Home Settings	`home_settings`	Code			yes
Gender	`gender`	Link				Gender
Birth Date	`birth_date`	Date
Interests	`interest`	Small Text
Phone	`phone`	Data
Location	`location`	Data
Bio	`bio`	Small Text
Mobile No	`mobile_no`	Data
Mute Sounds	`mute_sounds`	Check
Desk Theme	`desk_theme`	Select				one of: Light, Dark, Automatic
Banner Image	`banner_image`	Attach Image
Search Bar	`search_bar`	Check
Notifications	`notifications`	Check
Sidebar	`list_sidebar`	Check
Bulk Actions	`bulk_actions`	Check
View Switcher	`view_switcher`	Check
Sidebar	`form_sidebar`	Check
Timeline	`timeline`	Check
Dashboard	`dashboard`	Check
Set New Password	`new_password`	Password
Logout From All Devices After Changing Password	`logout_all_sessions`	Check
Reset Password Key	`reset_password_key`	Data		yes	yes
Last Reset Password Key Generated On	`last_reset_password_key_generated_on`	Datetime		yes	yes
Last Password Reset Date	`last_password_reset_date`	Date		yes	yes
Redirect URL	`redirect_url`	Small Text			yes
Send Notifications For Documents Followed By Me	`document_follow_notify`	Check
Frequency	`document_follow_frequency`	Select				one of: Hourly, Daily, Weekly
Auto follow documents that you create	`follow_created_documents`	Check
Auto follow documents that you comment on	`follow_commented_documents`	Check
Auto follow documents that you Like	`follow_liked_documents`	Check
Auto follow documents that are assigned to you	`follow_assigned_documents`	Check
Auto follow documents that are shared with you	`follow_shared_documents`	Check
Email Signature	`email_signature`	Small Text
Send Notifications For Email Threads	`thread_notify`	Check
Send Me A Copy of Outgoing Emails	`send_me_a_copy`	Check
Allowed In Mentions	`allowed_in_mentions`	Check
User Emails	`user_emails`	Table				User Email
Default Workspace	`default_workspace`	Link				Workspace
Default App	`default_app`	Select
User Defaults	`defaults`	Table			yes	DefaultValue
Simultaneous Sessions	`simultaneous_sessions`	Int
Restrict IP	`restrict_ip`	Small Text
Last IP	`last_ip`	Read Only		yes
Login After	`login_after`	Int
User Type	`user_type`	Link				User Type
Last Active	`last_active`	Datetime		yes
Login Before	`login_before`	Int
Bypass Restricted IP Address Check If Two Factor Auth Enabled	`bypass_restrict_ip_check_if_2fa_enabled`	Check
Last Login	`last_login`	Read Only		yes
Last Known Versions	`last_known_versions`	Text		yes	yes
Social Logins	`social_logins`	Table				User Social Login
API Key	`api_key`	Data		yes
API Secret	`api_secret`	Password		yes
Onboarding Status	`onboarding_status`	Small Text			yes
Allow Access to Stores (added by iVendNext)	`custom_allow_access_to_stores`	Table				Store Detail
Default Shift Profile (added by iVendNext)	`custom_shift_profile`	Link				POS Shift Profile
QR/Bar Code (added by iVendNext)	`custom_qr_code`	Data
MSR Code (added by iVendNext)	`custom_msr_code`	Data

Table: Block Module

The rows of block_modules. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Module	`module`	Data	yes

Table: DefaultValue

The rows of defaults. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Key	`defkey`	Data	yes
Value	`defvalue`	Text

Table: Has Role

The rows of roles. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Role	`role`	Link				Role

Table: Store Detail

The rows of custom_allow_access_to_stores. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Store	`warehouse`	Link				Warehouse
POS Profile	`pos`	Link				POS Profile

Table: User Email

The rows of user_emails. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Links to
Email Account	`email_account`	Link	yes		Email Account
Email ID	`email_id`	Data		yes
Awaiting Password	`awaiting_password`	Check		yes
Used OAuth	`used_oauth`	Check		yes
Enable Outgoing	`enable_outgoing`	Check		yes

The rows of social_logins. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Read-only
Provider	`provider`	Data	yes
Username	`username`	Data	yes
User ID	`userid`	Data	yes

All record types · What you can use

This record type in the kit