User Entity

{
    user: {
        idUser:                     // user ID
        username:                   // username
        registrationDate:           // date of registration
        isCommercial:               // 0: private user
                                    // 1: commercial user
                                    // 2: powerseller 
        isSeller:                   // indicates if the user can sell; true|false
        name: {                     // name entity
            company:                // company name; only returned for commercial users
            firstName:              // first name
            lastName:               // last name; only returned for commercial users
        }
        address: {}                 // Address entity
        phone:                      // phone number; only returned for commercial users
        email:                      // email address; only returned for commercial users
        vat:                        // tax number; only returned for commercial users
        riskGroup:                  // 0: no risk
                                    // 1: low risk
                                    // 2: high risk
        reputation:                 // 0: not enough sells to rate
                                    // 1: outstanding seller
                                    // 2: very good seller
                                    // 3: good seller
                                    // 4: average seller
                                    // 5: bad seller
        shipsFast:                  // Expected amount of days it will take to receive an order placed from this seller
        sellCount:                  // number of sales
        soldItems:                  // total number of sold items
        avgShippingTime:            // average shipping time
        onVacation:                 // true|false
        links: []                   // HATEOAS links
    }
}

The shown entity is returned for users other than the authenticated, i.e. as a seller for articles, or in orders, the shopping cart, as the message partner in the message management, etc.

For requests in the Account Management group, where your own account is returned, see Account entity.

Depending on the private/commercial status of a user, different information for the name and address entities are returned:

• name - firstName for all
• name - all other only for commercial
• address - country< for all
• address - all other only for commercial

This does not apply for the shipping address in the shopping cart or in orders.

See also:

• Address Entity

The country value is returned as ISO 3166-1 alpha-2 code, except for Germany, which is only D (instead of DE).

The idDisplayLanguage is currently only used for the MKM mobile website.

For the links, see HATEOAS Links

Example Entities

Commercial account

{
    account: {
        idUser: 9999
        username: "Maxi"
        registerDate: "2014-04-10T08:09:02+0200"
        isCommercial: 1
        isSeller: true
        name: {
            companyName: "Maxi's Top-Seller"
            firstName: "Maximilian"
            lastName: "Mustermann"
        }
        address: {
            name: "Maximilian Mustermann"
            extra: "c/o Musterfrau"
            street: "Hauptweg 15"
            zip: "12345"
            city: "Berlin"
            country: "D"
        }
        phoneNumber: "+49 30 1234567"
        email: "max.mustermann@gmail.de"
        vat: "1234567890"
        riskGroup: 0
        reputation: 1
        shipsFast: 3
        sellCount: 254
        soldItems: 1355
        avgShippingTime: 1
        onVacation: false
        links: {}
    }
}

Private account

{
    account: {
        idUser: 9999
        username: "Maxi"
        registerDate: "2014-04-10T08:09:02+0200"
        isCommercial: 0
        isSeller: false
        name: {
            firstName: "Maximilian"
        }
        address: {
            country: "D"
        }
        phoneNumber: ""
        email: ""
        vat: ""
        riskGroup: 0
        reputation: 1
        shipsFast: 5
        sellCount: 254
        soldItems: 1355
        avgShippingTime: 1
        onVacation: false
        links: {}
    }
}