SearchResult«EndUser» resource

Methods

  • get - Get list of end-users

Resource

{
    "items": [
        {
            "accountCreated": "boolean",
            "city": "string",
            "company": {
                "cnpj": "string",
                "companyName": "string",
                "vatNumber": "string"
            },
            "country": "string",
            "cpf": "string",
            "createDate": "date-time",
            "customerId": "string",
            "dbVersion": "int64",
            "email": "string",
            "emails": [
                {
                    "createDate": "date-time",
                    "emailId": "string",
                    "error": "string",
                    "id": "string",
                    "type": "string"
                }
            ],
            "firstName": "string",
            "id": "string",
            "lastName": "string",
            "locale": "string",
            "status": "string",
            "storeId": "string",
            "streetAddress": "string",
            "token": "string",
            "updateDate": "date-time",
            "wallet": {
                "creditCards": [
                    {
                        "active": "boolean",
                        "bin": "string",
                        "expirationDate": "string",
                        "hash": "string",
                        "id": "string",
                        "paymentMethodType": "string",
                        "status": "string",
                        "transactionIds": [
                            "string"
                        ],
                        "type": "string"
                    }
                ],
                "paymentMethodIdToUseForSubscriptionId": {
                    "<key>": "string"
                },
                "paypals": [
                    {
                        "active": "boolean",
                        "id": "string",
                        "paymentMethodType": "string",
                        "paypalPayerEmail": "string",
                        "paypalPayerFirstName": "string",
                        "paypalPayerLastName": "string",
                        "status": "string",
                        "transactionIds": [
                            "string"
                        ],
                        "type": "string"
                    }
                ],
                "recurringUnknowns": [
                    {
                        "active": "boolean",
                        "id": "string",
                        "name": "string",
                        "paymentMethodType": "string",
                        "status": "string",
                        "transactionIds": [
                            "string"
                        ],
                        "type": "string"
                    }
                ]
            },
            "zipCode": "string"
        }
    ],
    "last": "boolean",
    "number": "int32",
    "size": "int32",
    "totalItems": "int64",
    "totalPages": "int32"
}

Properties

Name Type Description Additional
items[] array Optional
items[].accountCreated boolean Optional
items[].city string

City

items[].company object Company Optional
items[].company.cnpj string

CPNJ

Optional
items[].company.companyName string

End-user company name

items[].company.vatNumber string

Company VAT number

Optional
items[].country string

Country

items[].cpf string

CPF value

items[].createDate date-time Optional
items[].customerId string

Customer ID

items[].dbVersion int64 Optional
items[].email string

Email

items[].emails[] array

List of emails sent to end-user

Optional
items[].emails[].createDate date-time

Creation date

Optional, read only.
items[].emails[].emailId string

Reference in email storage

Optional, read only.
items[].emails[].error string

Error message if error occurs while sending email

Optional, read only.
items[].emails[].id string

Email unique identifier

Optional, read only.
items[].emails[].type string

Mail type

Optional, read only.
items[].firstName string

First name

items[].id string Optional
items[].lastName string

Last name

items[].locale string

Locale used by end-user

items[].status string

Status

Possible values are:

  • ENABLED
  • DISABLED
Optional, read only.
items[].storeId string

Store ID

items[].streetAddress string

Street address

Optional
items[].token string

Create token to initiate and reset password

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

List of credit cards

Optional
items[].wallet.creditCards[].active boolean Optional
items[].wallet.creditCards[].bin string Optional
items[].wallet.creditCards[].expirationDate string

Expiration date

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

Reference ID

Optional
items[].wallet.creditCards[].paymentMethodType string

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

Possible values are:

  • CreditCard
  • Paypal
  • NonRecurringUnknown
  • RecurringUnknown
Optional
items[].wallet.creditCards[].status string

Activation status

Possible values are:

  • ACTIVATED
  • PENDING
  • ERROR
Optional
items[].wallet.creditCards[].transactionIds[] array of string

List of transaction IDs

Optional
items[].wallet.creditCards[].type string

Type in DP

Optional
items[].wallet.paymentMethodIdToUseForSubscriptionId object

List of credit card use for each subscription

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

List of PayPal accounts

Optional
items[].wallet.paypals[].active boolean Optional
items[].wallet.paypals[].id string

Reference ID

Optional
items[].wallet.paypals[].paymentMethodType string

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

Possible values are:

  • CreditCard
  • Paypal
  • NonRecurringUnknown
  • RecurringUnknown
Optional
items[].wallet.paypals[].paypalPayerEmail string

PayPal payer email

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

PayPal payer first name

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

PayPal payer last name

Optional, read only.
items[].wallet.paypals[].status string

Activation status

Possible values are:

  • ACTIVATED
  • PENDING
  • ERROR
Optional
items[].wallet.paypals[].transactionIds[] array of string

List of transaction IDs

Optional
items[].wallet.paypals[].type string

Type in DP

Optional
items[].wallet.recurringUnknowns[] array

List of recurring unknown payment methods

Optional
items[].wallet.recurringUnknowns[].active boolean Optional
items[].wallet.recurringUnknowns[].id string

Reference ID

Optional
items[].wallet.recurringUnknowns[].name string Optional
items[].wallet.recurringUnknowns[].paymentMethodType string

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

Possible values are:

  • CreditCard
  • Paypal
  • NonRecurringUnknown
  • RecurringUnknown
Optional
items[].wallet.recurringUnknowns[].status string

Activation status

Possible values are:

  • ACTIVATED
  • PENDING
  • ERROR
Optional
items[].wallet.recurringUnknowns[].transactionIds[] array of string

List of transaction IDs

Optional
items[].wallet.recurringUnknowns[].type string

Type in DP

Optional
items[].zipCode string

Zip/postal code of town

Optional
last boolean Optional
number int32 Optional
size int32 Optional
totalItems int64 Optional
totalPages int32 Optional