Customer

Structure

FieldTypeRequiredDescription
idintfalseUnique identifier for the Customer.
namestringtrueName of the Customer.
customerDocumentListList of CustomerDocumenttrue
customerEmailListList of CustomerEmailfalse
customerAddressListList of CustomerAddressfalse
customerPhoneListList of CustomerPhonefalse
profileTypeProfileTypefalse
customerCustomFieldValueListList of CustomerCustomFieldValuefalse
customerLoyaltyListList of CustomerLoyaltyfalse
chainVipLevelchainVipLevelfalseOnly for get/list. Not for save/update/delete.

JSON representation

{
	"id": 508,
	"name": "John J Jason",
	"customerDocumentList": [{
		"id": 131,
		"primary": true,
		"documentType": {
			"id": 5,
			"code": "5",
			"name": "National identity document"
		},
		"number": "DOC 1",
		"givenName": "John",
		"secondSurName": "J",
		"surName": "Jason",
		"genderType": {
			"id": 1,
			"code": "M",
			"name": "Male"
		},
		"birthDate": "2000-01-01",
		"birthCountryCode": "ES",
		"birthPlace": "Washington",
		"effectiveDate": "2015-06-15",
		"expireDate": "2020-01-01",
		"street": null,
		"city": null,
		"stateProvName": "District of Columbia",
		"stateProv": "ES-B",
		"countryCode": "ES",
		"postalCode": "56944",
		"nationalityCountryCode": "ES",
		"countryOfIssuanceCode": "ES",
		"ocr": null,
		"remark": "Document Remark"
	}],
	"customerEmailList": null,
	"customerAddressList": [{
		"id": 386,
		"primary": true,
		"communicationLocationType": {
			"id": 1,
			"code": "1",
			"name": "Home"
		},
		"street": "4 Service Court",
		"city": "Washington",
		"stateProvName": "District of Columbia",
		"stateProv": null,
		"postalCode": "56944",
		"countryCode": "ES",
		"remark": "Address Remark"
	}],
	"customerPhoneList": [{
		"id": 506,
		"primary": true,
		"phoneLocationType": {
			"id": 6,
			"code": "6",
			"name": "Home"
		},
		"phoneTechType": {
			"id": 1,
			"code": "1",
			"name": "Voice"
		},
		"countryAccessCode": "+34",
		"areaCityCode": "B",
		"phoneNumber": "1-(202)867-6315",
		"extension": "1",
		"remark": "Phone Remark"
	}],
	"remark": "Customer Remarks",
	"customerCustomFieldValueList": [
        {
            "id": null,
            "code": "SMOKER",
            "name": "Smoker",
            "customFieldId": 1,
            "booleanValue": null,
            "numberValue": null,
            "stringValue": null,
            "dateValue": null,
            "selectValue": null,
            "multiSelectValueList": null
        }
	],
    "profileType": {
         "code": "1",
         "name": "Customer",
         "nameI18n": "Customer",
         "colorCode": "#00ACC1"
    },
	"customerLoyaltyList": [
        {
            "id": 16,
            "chainLoyalty": {
                "id": 1,
                "programId": "IB",
                "name": "IberiaPlus",
                "propertyLoyaltyList": [
                    {
                        "id": 1,
                        "active": true,
                        "inactiveReason": null
                    } ...
				]
			},
			"membershipId": "33333333333A"
        } ...
	],
	"chainVIPLevel": {
        "id": 4,
        "chainId": 1,
        "code": "VI",
        "name": "Vino",
        "colorCode": "#6D4C41",
        "remark": "Set de Vino en la habitación",
        "active": false,
        "createdDate": "2024-03-13T09:48:53.3007728",
        "modifiedDate": null
    }
}