Helpcenter +918010117117 https://help.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" [email protected] https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India

Related Topics

StoreHippo API Global Widgets Global Objects

Resources

Overview ms.blogs ms.brands ms.carts ms.categories ms.collections ms.coupon_codes ms.discounts_new ms.domains ms.email_logs ms.enquiries ms.fulfillments ms.invoices ms.languages ms.mailing_lists ms.navigations ms.notifications ms.orders ms.pages ms.products ms.redirects ms.reviews ms.sellers ms.ssl_certificates ms.store_ledger ms.store_locations ms.users

Users

(ms.users)

you need swagger

Stores the information about customer and admin users. Customer objects allow you to perform recurring charges and track multiple charges that are associated with the same customer. The API allows you to create, delete, and update your customers. You can retrieve individual customers as well as a list of all your customers.

Fields

Name Description
first_name
Type: string
 		First name of user. Example:

dennis
last_name
Type: string
 		Last name of user. Example:

ritchie
email
Type: string
 Required 		Email address associated with user account. Example:

[email protected]
Password
Type: string
 Required 		Password of user in encrypted form. Example:

************
Image
Type: file
 		Image field contains the url of image of user. Example:

http://example.com/burton.jpg
Phone
Type: string
 		Phone no of user. Example:

8895656388
gender
Type: string
 		Gender of user Example:

Female
active
Type: string
 		Enable it if the user is active. It is checked by default but if the user is inactive, you can disable it. Example:

1
customer_groups
Type: array
 		It holds the names of groups that a customer belongs to. Example: 
"customer_groups": ["retailers", "distributors"]
role
Type: string
 		Roles are assigned to the users when they register to your store. Custom roles can also be added. Example:

seller
email_verified
Type: string
 		Enable this flag, if the email of the user is verified. Example:

1
phone_veified
Type: string
 		Enable this flag, if the phone number of the user is verified. Example:

1
use_temporary_password
Type: string
 		Enable this field if you want to enable automatic generation of temporary password when you add a new user. Example:

0

Commands

Name Routes
add post  /api/1/entity/ms.users TRY IT !
edit put  /api/1/entity/ms.users/{_id} TRY IT !
list get  /api/1/entity/ms.users TRY IT !
get get  /api/1/entity/ms.users/{_id} TRY IT !
delete delete  /api/1/entity/ms.users/{_id} TRY IT !

Users

(ms.users)

you need swagger

Stores the information about customer and admin users. Customer objects allow you to perform recurring charges and track multiple charges that are associated with the same customer. The API allows you to create, delete, and update your customers. You can retrieve individual customers as well as a list of all your customers.

Fields

Name Description
first_name
Type: string
 		First name of user. Example:

dennis

last_name
Type: string
 		Last name of user. Example:

ritchie

email
Type: string
 Required 		Email address associated with user account. Example:

[email protected]

Password
Type: string
 Required 		Password of user in encrypted form. Example:

************

Image
Type: file
 		Image field contains the url of image of user. Example:

http://example.com/burton.jpg

Dob
Type: datetime
 		Date of birth of user. Example:

04/23/2018

Phone
Type: string
 		Phone no of user. Example:

8895656388

gender
Type: string
 		Gender of user Example:

Female

active
Type: string
 		Enable it if the user is active. It is checked by default but if the user is inactive, you can disable it. Example:

1

addresses
Type: array

last_shipping_address
Type: string

last_billing_address
Type: string

account
Type: array

wishlist
Type: array

customer_groups
Type: array
 		It holds the names of groups that a customer belongs to. Example: 
"customer_groups": ["retailers", "distributors"]

notes
Type: array

verified
Type: string

dates
Type: string

role
Type: string
 		Roles are assigned to the users when they register to your store. Custom roles can also be added. Example:

seller

verified_text
Type: string

verified_time
Type: string

history
Type: string

email_verified
Type: string
 		Enable this flag, if the email of the user is verified. Example:

1

phone_veified
Type: string
 		Enable this flag, if the phone number of the user is verified. Example:

1

use_temporary_password
Type: string
 		Enable this field if you want to enable automatic generation of temporary password when you add a new user. Example:

0

roles
Type: array
 		This field stores secondary roles. A user whose role is "superadmin" can also be a "seller" and "retailer".So, roles is an array where several roles are stored. Example: 
"roles":["seller","retailer"]

Commands

Name Routes
add post  /api/1/entity/ms.users TRY IT !
edit put  /api/1/entity/ms.users/{_id} TRY IT !
list get  /api/1/entity/ms.users TRY IT !
get get  /api/1/entity/ms.users/{_id} TRY IT !
delete delete  /api/1/entity/ms.users/{_id} TRY IT !