Objects

DashboardUser

Profile information of a dashboard user.

{
    "id": "1",
    "first_name": "John",
    "last_name": "Down",
    "created": <DateTime>,
    "email": "[email protected]",
    "phone": "0791234567",
    "permissions": {
        "analytics": true,
        "appearance": true,
        "customers": true,
        "home": true,
        "orders": true,
        "products": true,
        "settings": true
    }
}

For more details on the permissions field see Authorization.

Tenant

Account information of a platform tenant.

{
    "id": "1",
    "name": "matjar",
    "owner": <DashboardUser>,
    "country": "JO",    
    "store_host": "matjar.myshopgo.me",
    "subscribed": "active",
    "timezone": "Asia/Amman",
    "permissions": {
        "home": true,
        "orders": true,
        "products": true,
        "customers": true,
        "analytics": true,
        "appearance": true,
        "settings": true
    },
}

where the parameters are ...

Name	Description
name	A unique but mutable tenant identifier
owner	Dashboard user who created and owns the tenant account
country	Tenant country setting (ISO 3166-1 alpha-2 code)
store_host	The most recent tenant store website hostname
subscribed	Plan subscription status (either active or expired)
timezone	Tenant timezone setting (tz timezone String)
permissions	Dashboard permissions (as described in Authorization)