User

Request

Fields when send to the api inside a request.

Field Type Description
firstname String A String value
lastname String A String value
email Email Email address
telephone Phone International phone number
notifications UserNotifications Information about the notifications a user want to receive

Response

Fields when returned by the api in a response.

Field Type Description
firstname String A String value
lastname String A String value
email Email 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

Examples

Request

When used inside a request.

Example 1

{
    "firstname": "string",
    "lastname": "string",
    "email": "example@domain.com",
    "telephone": "+32 475 00 00 00",
    "notifications": {
        "email_when_order": true,
        "email_when_comment": true,
        "email_when_order_confirmed": true,
        "email_when_order_cancel": true,
        "email_when_newsletter": true
    }
}

Response

When returned in a response.

Example 1

{
    "firstname": "string",
    "lastname": "string",
    "email": "example@domain.com",
    "telephone": "+32 475 00 00 00",
    "notifications": {
        "email_when_order": true,
        "email_when_comment": true,
        "email_when_order_confirmed": true,
        "email_when_order_cancel": true,
        "email_when_newsletter": true
    },
    "id": 12,
    "delivery_address": {
        "street": "Vermeerschdreef",
        "nr": "40",
        "zipcode": "2970",
        "city": "Ronse",
        "country": "BE"
    },
    "company": {
        "name": "string",
        "vat": "string",
        "address": {
            "street": "string",
            "nr": "string",
            "zipcode": "string",
            "city": "string",
            "country": "BE"
        }
    },
    "bank_account_number": "string"
}
1.5.0 stable