Customer Details
Use customers.customer with the publicKey of the customer to read the profile and the loyalty data of one customer.
Query
query GetCustomerDetails($customer: [Guid]) {
customers {
customer(publicKey: $customer) {
items {
publicKey
firstName
lastName
active
code
email
mobilePhone
workPhone
homePhone
birthDate
category { publicKey name }
segmentationCategory { publicKey name }
loyalty {
points { balance }
wallet { balance }
}
addresses {
publicKey
streetName
streetNumber
buildingNumber
staircase
floor
roomNumber
intercom
landmark
}
companies {
publicKey
isPrimaryContact
isPrimaryDelegate
company { publicKey name fiscalCode }
}
marketingActions {
value
marketingAction { publicKey name }
}
}
}
}
}Variables
{
"customer": [
"<customer key>"
]
}cURL
curl --location 'https://sandbox.expressoft.eu/connect/api/interopgql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{"query": "query GetCustomerDetails($customer: [Guid]) { customers { customer(publicKey: $customer) { items { publicKey firstName lastName active code email mobilePhone workPhone homePhone birthDate category { publicKey name } segmentationCategory { publicKey name } loyalty { points { balance } wallet { balance } } addresses { publicKey streetName streetNumber buildingNumber staircase floor roomNumber intercom landmark } companies { publicKey isPrimaryContact isPrimaryDelegate company { publicKey name fiscalCode } } marketingActions { value marketingAction { publicKey name } } } } } }", "variables": {"customer": ["<customer key>"]}}'Response
{
"data": {
"customers": {
"customer": {
"items": [
{
"publicKey": "00000000-0000-0000-0000-000000000001",
"firstName": "Jane",
"lastName": "Doe",
"active": true,
"code": "ADD1",
"email": "[email protected]",
"mobilePhone": "0700000001",
"workPhone": null,
"homePhone": null,
"birthDate": "1990-05-20T00:00:00",
"category": {
"publicKey": "00000000-0000-0000-0000-000000000010",
"name": "Gold customers"
},
"segmentationCategory": null,
"loyalty": {
"points": {
"balance": 5.61
},
"wallet": {
"balance": 0.0
}
},
"addresses": [
{
"publicKey": "00000000-0000-0000-0000-000000000011",
"streetName": "Sample Street",
"streetNumber": "12",
"buildingNumber": "B",
"staircase": "1",
"floor": "3",
"roomNumber": "9",
"intercom": "30",
"landmark": "Next to the park"
}
],
"companies": [],
"marketingActions": [
{
"value": true,
"marketingAction": {
"publicKey": "00000000-0000-0000-0000-000000000021",
"name": "Newsletter"
}
}
]
}
]
}
}
}
}Loyalty data
Field | Meaning |
|---|---|
loyalty.points.balance | The current loyalty points balance of the customer. |
loyalty.wallet.balance | The wallet balance of the customer (the debit amount, with VAT). |
segmentationCategory | The segment of the customer. null when none is assigned. |
Points and amounts are decimal numbers, for example 5.61. To see how the points changed, see Points Balance & Transactions. For the vouchers of the customer, see Vouchers.
Other fields
Field | Meaning |
|---|---|
addresses | The addresses of the customer. Pass publicKey to read one address. |
companies | The companies linked to the customer (B2B). |
marketingActions | The marketing consents of the customer. value is true for opt-in and false for opt-out. |