EndUser resource

Methods

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

Resource

{
    "accountCreated": "boolean",
    "city": "string",
    "company": {
        "companyId": "string",
        "companyName": "string",
        "vatNumber": "string"
    },
    "country": "string",
    "createDate": "date-time",
    "dbVersion": "int64",
    "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",
    "modelVersion": "string",
    "status": "string",
    "storeId": "string",
    "streetAddress": "string",
    "token": "string",
    "updateDate": "date-time",
    "wallet": {
        "creditCards": [
            {
                "bin": "string",
                "expirationDate": "string",
                "hash": "string",
                "id": "string",
                "paymentMethodType": "string",
                "transactionIds": [
                    "string"
                ],
                "type": "string"
            }
        ],
        "paymentMethodIdToUseForSubscriptionId": {
            "<key>": "string"
        },
        "paypals": [
            {
                "id": "string",
                "paymentMethodType": "string",
                "paypalPayerEmail": "string",
                "paypalPayerFirstName": "string",
                "paypalPayerLastName": "string",
                "transactionIds": [
                    "string"
                ]
            }
        ]
    },
    "zipCode": "string"
}

Properties

Name Type Description Additional
accountCreated boolean Optional
city string

City

company object Company Optional
company.companyId string

Company ID

Optional
company.companyName string

End-user company name

company.vatNumber string

Company VAT number

Optional
country string

Country

createDate date-time Optional
dbVersion int64 Optional
email string

Email

emails[] array

List of email send at the user

Optional
emails[].createDate date-time

Creation date

Optional, read only.
emails[].emailId string

Reference in mail storage

Optional, read only.
emails[].error string

Error message if error occurs while sending email

Optional, read only.
emails[].id string

Unique identifier

Optional, read only.
emails[].type string

Mail type

Optional, read only.
firstName string

First name

id string Optional
identity object Identity Optional
identity.identityType string

Entity type

identity.identityValue string

Entity value

lastName string

Last name

locale string

Locale use by the end user

modelVersion string Optional
status string

Status

Possible values are:

  • ENABLED
  • DISABLED
Optional, read only.
storeId string

Store id

streetAddress string

Street address

token string

Token create for initiate and reset the password

Optional
updateDate date-time Optional
wallet object Wallet Optional
wallet.creditCards[] array

List of credit cards

Optional
wallet.creditCards[].bin string Optional
wallet.creditCards[].expirationDate string

Expiration date

Optional
wallet.creditCards[].hash string Optional
wallet.creditCards[].id string

Reference ID

Optional
wallet.creditCards[].paymentMethodType string

Type of payment method (ex: Credit card, Paypal)

Possible values are:

  • CreditCard
  • Paypal
Optional
wallet.creditCards[].transactionIds[] array of string

List of transaction IDs

Optional
wallet.creditCards[].type string

Type of credit card (ex: VISA, MASTERCARD)

Optional
wallet.paymentMethodIdToUseForSubscriptionId object

List of credit card use for each subscription

Optional
wallet.paymentMethodIdToUseForSubscriptionId.<key> map of string Optional
wallet.paypals[] array

List of paypal account

Optional
wallet.paypals[].id string

Reference ID

Optional
wallet.paypals[].paymentMethodType string

Type of payment method (ex: Credit card, Paypal)

Possible values are:

  • CreditCard
  • Paypal
Optional
wallet.paypals[].paypalPayerEmail string

paypal payer email

Optional, read only.
wallet.paypals[].paypalPayerFirstName string

paypal payer first Name

Optional, read only.
wallet.paypals[].paypalPayerLastName string

paypal payer last name

Optional, read only.
wallet.paypals[].transactionIds[] array of string

List of transaction IDs

Optional
zipCode string

Zipcode of the town

Optional

Example

{
    "company": {},
    "identity": {},
    "wallet": {}
}