Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| firstname | String | A String value |
| lastname | String | A String value |
| Email address | ||
| telephone | Phone | International phone number |
| notifications | UserNotifications | Information about the notifications a user want to receive |
| tin_nr | String | A String value |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| firstname | String | A String value |
| lastname | String | A String value |
| Email address | ||
| telephone | Phone | International phone number |
| notifications | UserNotifications | Information about the notifications a user want to receive |
| id | Int | An integer value |
| delivery_address | Address.simple? | Nullable. An address |
| company | Checkout.Company? | Nullable. |
| bank_account_number | String? | Nullable. A String value |
| tin_nr | String | A String value |
| company_permissions | [UserCompanyPermission] | Optional. Array of UserCompanyPermission |
When used inside a request.
{
"firstname": "...",
"lastname": "...",
"email": "example@domain.com",
"telephone": "+32 475 00 00 00",
"notifications": {
"email_when_order": true,
"email_when_comment": true,
"email_when_order_confirmed": false,
"email_when_order_cancel": true,
"email_when_newsletter": true
},
"tin_nr": "..."
}When returned in a response.
{
"firstname": "...",
"lastname": "...",
"email": "example@domain.com",
"telephone": "+32 475 00 00 00",
"notifications": {
"email_when_order": false,
"email_when_comment": false,
"email_when_order_confirmed": true,
"email_when_order_cancel": false,
"email_when_newsletter": false
},
"id": 18,
"delivery_address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"company": {
"name": "...",
"vat": "BE0123456789",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
}
},
"bank_account_number": "...",
"tin_nr": "...",
"company_permissions": [
{
"shop_ids": [
17,
17,
12
],
"permissions": {
"company_info": true,
"holidays": false,
"newsletters": false,
"translations": true,
"email_settings": true,
"products": false,
"shop_info": true,
"checkout_settings": false,
"time_settings": true,
"discounts": true
},
"id": 10,
"company_id": 18
},
{
"shop_ids": [
18,
14,
11
],
"permissions": {
"company_info": false,
"holidays": true,
"newsletters": true,
"translations": true,
"email_settings": false,
"products": true,
"shop_info": false,
"checkout_settings": false,
"time_settings": false,
"discounts": true
},
"id": 14,
"company_id": 16
},
{
"shop_ids": [
14,
10,
12
],
"permissions": {
"company_info": true,
"holidays": false,
"newsletters": false,
"translations": false,
"email_settings": true,
"products": false,
"shop_info": true,
"checkout_settings": false,
"time_settings": true,
"discounts": false
},
"id": 15,
"company_id": 14
}
]
}