Skip to main content

Customer

No description

type Customer implements IBaseUser {
customerId: Int!
addresses(
type: AddressType
isDefault: YesNo
): [Address!]!
id: Int! @deprecated
attributes(
filter: AttributeFilterInput
): [Attribute!]! @deprecated
attributeValues(
filter: AttributeFilterInput
): AttributeValueResponse!
favoriteLists(
input: FavoriteListsBaseSearchInput
): FavoriteListsResponse
orderlist: Orderlist
debtorId: String
gender: Gender
firstName: String!
middleName: String
lastName: String!
phone: String
mobile: String
email: String!
iban: String
bankAccount: String
bic: String
notes: String
primaryLanguage: String
expires: DateTime
externalId: String
dateOfBirth: DateTime
mailingList: YesNo
isLoggedIn: Boolean
dateCreated: DateTime
lastModifiedDate: DateTime
parentUsergroupId: Int!
usergroup: Usergroup
usergroupPath: [Usergroup!]!
}

Fields

Customer.customerId ● Int! non-null scalar

The id of the customer.

Customer.addresses ● [Address!]! non-null object

Customer.addresses.type ● AddressType enum
Customer.addresses.isDefault ● YesNo enum

Customer.id ● Int! deprecated non-null scalar

DEPRECATED

This property is no longer relevant or necessary, use customerId instead.

The unique identifier of the user.

Customer.attributes ● [Attribute!]! deprecated non-null object

DEPRECATED

Deprecated is favour of attributeValues. Added pagination to ther query the default offset will be 12 values. Increasing the offset in a listed view will impact the performance of the api.

Returns an array of legacy Attribute Entities

Customer.attributes.filter ● AttributeFilterInput input

Customer.attributeValues ● AttributeValueResponse! non-null object

Returns a paginated response of AttributeValues

Customer.attributeValues.filter ● AttributeFilterInput input

Customer.favoriteLists ● FavoriteListsResponse object

Customer.favoriteLists.input ● FavoriteListsBaseSearchInput input

Customer.orderlist ● Orderlist object

Customer.debtorId ● String scalar

Customer.gender ● Gender enum

The gender of the user.

Customer.firstName ● String! non-null scalar

The first name of the user.

Customer.middleName ● String scalar

The middle name of the user.

Customer.lastName ● String! non-null scalar

The last name of the user.

Customer.phone ● String scalar

The phone number of the user.

Customer.mobile ● String scalar

The mobile number of the user.

Customer.email ● String! non-null scalar

The email of the user.

Customer.iban ● String scalar

The International Bank Account Number of the user

Customer.bankAccount ● String scalar

The Bank Account Number of the user

Customer.bic ● String scalar

The Bank Identification Code of the user

Customer.notes ● String scalar

Customer.primaryLanguage ● String scalar

The primary language of the user

Customer.expires ● DateTime scalar

The expiration date of the contact. After this date expires contact will be disabled.

Customer.externalId ● String scalar

External ID

Customer.dateOfBirth ● DateTime scalar

The date of birth of the contact.

Customer.mailingList ● YesNo enum

Customer.isLoggedIn ● Boolean scalar

Customer.dateCreated ● DateTime scalar

Customer.lastModifiedDate ● DateTime scalar

Customer.parentUsergroupId ● Int! non-null scalar

The usergroup id of parent usergroup.

Customer.usergroup ● Usergroup object

Customer.usergroupPath ● [Usergroup!]! non-null object

Interfaces

IBaseUser interface

Interface for the BaseUser Type, where both Contacts and Customers derive from

Returned By

customer query ● customerCreate mutation ● customerUpdate mutation

Member Of

CustomersResponse object ● Usergroup object