EndUser resource

Methods

  • post - Create a new enduser
  • get - Get an enduser by id
  • get - Get an enduser by store and email
  • put - Initialize enduser's password
  • put - Enduser: Initialize password
  • put - Update an enduser
  • put - Update enduser's password

Resource

{
    "accountCreated": "boolean",
    "city": "string",
    "company": {
        "companyId": "string",
        "companyName": "string",
        "vatNumber": "string"
    },
    "country": "string",
    "createdAt": "date-time",
    "email": "string",
    "emails": [
        {
            "createDate": "date-time",
            "emailId": "string",
            "error": "string",
            "id": "string",
            "type": "string"
        }
    ],
    "firstName": "string",
    "id": "string",
    "identity": {
        "identityType": "string",
        "identityValue": "string"
    },
    "lastName": "string",
    "locale": "string",
    "password": "string",
    "status": "string",
    "storeId": "string",
    "streetAddress": "string",
    "token": "string",
    "updatedAt": "date-time",
    "zipCode": "string"
}

Properties

Name Type Description Additional
accountCreated boolean Optional
city string

Enduser city

Optional
company object Company Optional
company.companyId string

Company id (like cpnj...)

Optional
company.companyName string

Enduser company name

company.vatNumber string

Company vat number

Optional
country string

End user country (format ISO 3166-1 alpha-2)

createdAt date-time Optional
email string

Enduser email

emails[] array

The list of emails sent to this end user

Optional
emails[].createDate date-time Optional, read only.
emails[].emailId string

This is the reference of email in the MS mailstorage

Optional, read only.
emails[].error string

Error message if an error occurs while sending email

Optional, read only.
emails[].id string

This is the internal reference id

Optional, read only.
emails[].type string

Type of mail

Optional, read only.
firstName string

Enduser first name

id string

Enduser id

Optional, read only.
identity object Identity Optional
identity.identityType string

The type of entity

identity.identityValue string

The value of entity

lastName string

Enduser last name

locale string

Locale of the end user

password string

password

status string

Enduser status

Possible values are:

  • ENABLED
  • DISABLED
Optional, read only.
storeId string

Store id

streetAddress string

Address book street address

token string

Token for init password

Optional
updatedAt date-time

Enduser updating time

Optional, read only.
zipCode string

Enduser zipcode

Example

{
    "city": "San Francisco",
    "company": {
        "companyId": "86816775000155",
        "companyName": "Nexway",
        "vatNumber": "FR45619122-451"
    },
    "country": "FR",
    "email": "test@gmail.com",
    "firstName": "john",
    "id": "a0253398-b0c5-4c2d-a15f-bd97ea4be608",
    "identity": {
        "identityType": "CPF",
        "identityValue": "12345678909"
    },
    "lastName": "Doe",
    "locale": "fr-FR",
    "password": "XdefH!E",
    "status": "ENABLED",
    "storeId": "a0253398-b0c5-4c2d-a15f-bd97ea4be608",
    "streetAddress": "236 8th street",
    "token": "d7989ea85882d0c4f0acc0247a83bf5b",
    "zipCode": "48250"
}