Skip to main content

User

Version: 1.0

The User resource is currently only available to Haravan Plus Customers.

What you can do with User

The Haravan API lets you do the following with the User resource.

Properties


account_owner : bool

"account_owner": false

Identifies if the user is the owner of the Haravan account.

bio : string

"bio": "A person on a mission"

User-specified description of oneself.

email : string

The email address associated with this account.

first_name : string

"first_name": "Joe"

The first name of the account user.

id : number

"id":1234567890

The account id.

im : string

The IM account address.

last_name : string

"last_name": "Smith"

The last name of the account user.

permissions : array

"permissions":["limited", "orders", "products"]

The permissions that the account has. Users will either have "full" or "limited" permissions. Limited permissions are scoped to a user in that they can only view certain parts of the Haravan Admin. The types of permissions a limited user can have are as follows:

  • dashboard: Can see Shop performance and statistics
  • orders: Can view and modify orders
  • customers: Can view and modify customers
  • marketing: Can view and modify marketing related products such as discount codes
  • products: Can view and modify products
  • gift_cards: Can view and modify gift cards
  • pages: Can view and modify shop pages
  • links: Can view and modify links and link lists
  • themes: Can view and modify shop themes
  • applications: Can authorize the installation of third-party applications
  • preferences: Can view the preferences and configuration of a shop
  • reports: Can view and create reports

Endpoints

Retrieves a list of all users

GET
https://apis.haravan.com/com/users.json

Retrieves a list of all users.

  • GET https://apis.haravan.com/com/users.json
Details
HTTP/1.1 200 OK

{
"users": [
{
"account_owner": false,
"bio": null,
"email": "[email protected]",
"first_name": "Tèos",
"id": 200000665752,
"im": null,
"last_name": "Tony",
"phone": null,
"receive_announcements": 1,
"url": null,
"user_type": "invited",
"permissions": [
"Limit"
]
}
]
}

Retrieves single the user

GET
https://apis.haravan.com/com/users/{user_id}.json

Retrieves single the user.

  • GET https://apis.haravan.com/com/users/200000665752.json
Details
HTTP/1.1 200 OK

{
"user": {
"account_owner": false,
"bio": null,
"email": "[email protected]",
"first_name": "Tèos",
"id": 200000665752,
"im": null,
"last_name": "Tony",
"phone": null,
"receive_announcements": 1,
"url": null,
"user_type": "invited",
"permissions": [
"Limit"
]
}
}

Retrieves a list of all the group user

GET
https://apis.haravan.com/com/users/groups.json

Retrieves a list of all the group user.

  • GET https://apis.haravan.com/com/users/groups.json
Details
HTTP/1.1 200 OK

{
"user_groups": [
{
"id": 259160,
"name": "Danh sách nhân viên Địa điểm mặc định",
"type": "system",
"created_at": "2020-10-06T07:31:03.111Z",
"updated_at": "2020-10-06T07:31:03.111Z"
},
{
"id": 243586,
"name": "Địa điểm mặc định",
"type": "system",
"created_at": "2020-09-18T04:10:29.739Z",
"updated_at": "2020-09-18T04:10:29.739Z"
}
]
}