Skip to main content

Buyer Object

Description

Represents a buyer (customer) user account.

Declaration

type Buyer {
_id: ID!
created: Date!
updated: Date
lastLogin: Date
active: Boolean
birthdate: Date
firstName: String
lastName: String
email: String
name: String
path: String
telephone: String
organisation: String
taxNumber: String
lists: [BuyerList!]!
accountCreated: Boolean
addresses: [Address!]!
notes: String
verification: UserVerification
orderCount: Int
orderTotal: Float
creditNotesCount: Int
wantsCount: Int
vouchersCount: Int
type: String!
}

Fields

NameTypeDescription
_idID!Internal database identifier.
createdDate!Date when the buyer account was created.
updatedDateDate when the buyer account was last updated.
lastLoginDateDate of the buyer's last login.
activeBooleanWhether the buyer account is active.
birthdateDateBuyer's birthdate.
firstNameStringBuyer's first name.
lastNameStringBuyer's last name.
emailStringBuyer's email address.
nameStringBuyer's full name.
pathStringURL path to the buyer's profile page.
telephoneStringBuyer's telephone number.
organisationStringOrganization or company name.
taxNumberStringTax identification number.
lists[BuyerList!]!Customer lists the buyer is a member of.
accountCreatedBooleanWhether the buyer has created an account (vs. guest checkout).
addresses[Address!]!Saved addresses for the buyer.
notesStringNotes or comments about the buyer.
verificationUserVerificationEmail verification status and information.
orderCountIntTotal number of orders placed by the buyer.
orderTotalFloatTotal value of all orders placed by the buyer.
creditNotesCountIntNumber of credit notes issued to the buyer.
wantsCountIntNumber of items in the buyer's wantlist.
vouchersCountIntNumber of vouchers associated with the buyer.
typeString!User type (always "buyer" for buyer users).