Operation

Information of the operation

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/customer

Request

Property	Type	Required	Type parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
documentNumber	string	false	request parameter		document number of the customer
email	string	false	request parameter		email of the customer
offset	Integer	false	request parameter	0	Offset of the array of results.
limit	Integer	false	request parameter	10	Limit of results.
sort	string	false	request parameter	id	Property of the entity to sort by.
sortMode	string	false	request parameter	Asc	Mode of sorting.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/customer?email=sharvey29@clickbank.net&documentNumber=1234567V

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	int	false	Unique identifier for the Customer.
name	string	true	Name of the Customer.
customerDocumentList	List of CustomerDocument	true
customerEmailList	List of CustomerEmail	false
customerAddressList	List of CustomerAddress	false
customerPhoneList	List of CustomerPhone	false
profileType	ProfileType	false
customerCustomFieldValueList	List of CustomerCustomFieldValue	false
customerLoyaltyList	List of CustomerLoyalty	false
chainVipLevel	chainVipLevel	false	Only for get/list. Not for save/update/delete.

Example response

{
  "count": 47,
  "offset": 0,
  "limit": 2,
  "list": [
    {
      "id": 1320,
      "name": "Amanda Göstaa Torres",
      "customerDocumentList": [
        {
          "id": 47,
          "primary": true,
          "documentType": {
            "id": 5,
            "code": "5",
            "name": "National identity document"
          },
          "number": "DOC 1",
          "givenName": "Amanda",
          "secondSurName": "Göstaa",
          "surName": "Torres",
          "genderType": {
            "id": 1,
            "code": "M",
            "name": "Male"
          },
          "birthDate": "2000-01-01",
          "birthCountryCode": "ES",
          "birthPlace": "Augusta",
          "effectiveDate": "2015-06-15",
          "expireDate": "2020-01-01",
          "street": null,
          "city": null,
          "stateProvName": "Georgia",
          "stateProvCode": null,
          "countryCode": "TK",
          "postalCode": "30911",
          "nationalityCountryCode": "TK",
          "ocr": null,
          "remark": "Document Remark"
        }
      ],
      "customerEmailList": [
        {
          "id": 1322,
          "primary": true,
          "emailAddressType": {
            "id": 1,
            "code": "1",
            "name": "Personal"
          },
          "email": "atorresgu@clickbank.net",
          "remark": null
        }
      ],
      "customerAddressList": [
        {
          "id": 1287,
          "primary": true,
          "communicationLocationType": {
            "id": 1,
            "code": "1",
            "name": "Home"
          },
          "street": "95 Armistice Alley",
          "city": "Augusta",
          "stateProvName": "Georgia",
          "stateProvCode": null,
          "postalCode": "30911",
          "countryCode": "AU",
          "remark": "Address Remark"
        }
      ],
      "customerPhoneList": [
        {
          "id": 1322,
          "primary": true,
          "phoneLocationType": {
            "id": 6,
            "code": "6",
            "name": "Home"
          },
          "phoneTechType": {
            "id": 1,
            "code": "1",
            "name": "Voice"
          },
          "countryAccessCode": "+34",
          "areaCityCode": "B",
          "phoneNumber": "1-(706)821-6121",
          "extension": "1",
          "remark": "Phone Remark"
        }
      ],
      "remark": "Customer Remarks",
  	  "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
	    }
    },
    {
      "id": 1319,
      "name": "Amanda Göstaa Torres",
      "customerDocumentList": [
        {
          "id": 46,
          "primary": true,
          "documentType": {
            "id": 5,
            "code": "5",
            "name": "National identity document"
          },
          "number": "DOC 1",
          "givenName": "Amanda",
          "secondSurName": "Göstaa",
          "surName": "Torres",
          "genderType": {
            "id": 1,
            "code": "M",
            "name": "Male"
          },
          "birthDate": "2000-01-01",
          "birthCountryCode": "ES",
          "birthPlace": "Augusta",
          "effectiveDate": "2015-06-15",
          "expireDate": "2020-01-01",
          "street": null,
          "city": null,
          "stateProvName": "Georgia",
          "stateProvCode": null,
          "countryCode": "TK",
          "postalCode": "30911",
          "nationalityCountryCode": "TK",
          "ocr": null,
          "remark": "Document Remark"
        }
      ],
      "customerEmailList": [
        {
          "id": 1321,
          "primary": true,
          "emailAddressType": {
            "id": 1,
            "code": "1",
            "name": "Personal"
          },
          "email": "atorresgu@clickbank.net",
          "remark": null
        }
      ],
      "customerAddressList": [
        {
          "id": 1286,
          "primary": true,
          "communicationLocationType": {
            "id": 1,
            "code": "1",
            "name": "Home"
          },
          "street": "95 Armistice Alley",
          "city": "Augusta",
          "stateProvName": "Georgia",
          "stateProvCode": null,
          "postalCode": "30911",
          "countryCode": "AU",
          "remark": "Address Remark"
        }
      ],
      "customerPhoneList": [
        {
          "id": 1321,
          "primary": true,
          "phoneLocationType": {
            "id": 6,
            "code": "6",
            "name": "Home"
          },
          "phoneTechType": {
            "id": 1,
            "code": "1",
            "name": "Voice"
          },
          "countryAccessCode": "+34",
          "areaCityCode": "B",
          "phoneNumber": "1-(706)821-6121",
          "extension": "1",
          "remark": "Phone Remark"
        }
      ],
      "remark": "Customer Remarks",
	  "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
	    }
    }
  ]
}

Browser not supported