User
Represents user account data.
type User implements Node, ObjectWithMetadata {
id: ID!
metadata: [MetadataItem!]!
privateMetadata: [MetadataItem!]!
email: String!
firstName: String!
lastName: String!
companyName: String!
isActive: Boolean!
dateJoined: DateTime!
lastLogin: DateTime
lastStatusChangedAt: DateTime
personalPhone: String
externalId: String
externalSource: String
taxExemptCode: String
vatIdentificationNumber: String
externalPayoutAccountId: String
externalPayoutOnboardingUrl: String
defaultShippingAddress: Address
defaultBillingAddress: Address
externalInventoryId: String
isStaff: Boolean!
note: String
externalPayoutSource: UserExternalPayoutSource
addresses: [Address!]!
isAssignable: Boolean!
tenantId: String
avatar(
size: Int
): Image
checkout: Checkout
numOrders: Int
orderCount: Int
orderTotalAmount: Money
isMarketplaceOperator: Boolean!
orders(
filter: CustomerOrderFilterInput
sortBy: OrderSortingInput
before: String
after: String
first: Int
last: Int
): OrderCountableConnection!
nauticalOrders(
filter: CustomerNauticalOrderFilterInput
sortBy: OrderSortingInput
before: String
after: String
first: Int
last: Int
): NauticalOrderCountableConnection!
userPermissions: [UserPermission!]!
permissionGroups: [Group!]!
editableGroups: [Group!]!
events: [CustomerEvent!]!
storedPaymentSources: [PaymentSource!]!
seller: Seller
wishlist(
before: String
after: String
first: Int
last: Int
): WishlistItemCountableConnection!
wishlists(
before: String
after: String
first: Int
last: Int
): WishlistCountableConnection!
documents: [Document!]!
dashboardEmbeddingToken: String
customFields: [SelectedAttribute!]!
}
Fields
User.id ● ID! non-null scalar
The Globally Unique ID of this object
User.metadata ● [MetadataItem!]! non-null object
List of public metadata items. Can be accessed without permissions.
User.privateMetadata ● [MetadataItem!]! non-null object
List of private metadata items. Requires proper staff permissions to access.
User.email ● String! non-null scalar
User.firstName ● String! non-null scalar
User.lastName ● String! non-null scalar
User.companyName ● String! non-null scalar
User.isActive ● Boolean! non-null scalar
User.dateJoined ● DateTime! non-null scalar
User.lastLogin ● DateTime scalar
User.lastStatusChangedAt ● DateTime scalar
User.personalPhone ● String scalar
User.externalId ● String scalar
User.externalSource ● String scalar
User.taxExemptCode ● String scalar
User.vatIdentificationNumber ● String scalar
User.externalPayoutAccountId ● String scalar
User.externalPayoutOnboardingUrl ● String scalar
User.defaultShippingAddress ● Address object
User's default shipping address
User.defaultBillingAddress ● Address object
User's default billing address
User.externalInventoryId ● String scalar
User.isStaff ● Boolean! non-null scalar
Whether the user is a staff member (MPO or seller)
User.note ● String scalar
A note about the customer.
User.externalPayoutSource ● UserExternalPayoutSource enum
External payout source for the user
User.addresses ● [Address!]! non-null object
List of all user's addresses
User.isAssignable ● Boolean! non-null scalar
Whether the user can be assigned as seller owner
User.tenantId ● String scalar
The user's tenant ID (UUID)
User.avatar ● Image object
User's avatar image
User.avatar.size ● Int scalar
User.checkout ● Checkout object
Returns the last open checkout of this user.
User.numOrders ● Int scalar
Number of orders placed by the user.
User.orderCount ● Int scalar
Total count of NauticalOrders for this customer in the filtered date range (from placedOrders filter).
User.orderTotalAmount ● Money object
Total gross amount of NauticalOrders for this customer in the filtered date range (from placedOrders filter).
User.isMarketplaceOperator ● Boolean! non-null scalar
Whether this user is a marketplace operator (MPO).
User.orders ● OrderCountableConnection! non-null object
List of user's orders.
User.orders.filter ● CustomerOrderFilterInput input
User.orders.sortBy ● OrderSortingInput input
User.orders.before ● String scalar
Returns the items in the list that come before the specified cursor.
User.orders.after ● String scalar
Returns the items in the list that come after the specified cursor.
User.orders.first ● Int scalar
Returns the first n items from the list.
User.orders.last ● Int scalar
Returns the items in the list that come after the specified cursor.
User.nauticalOrders ● NauticalOrderCountableConnection! non-null object
List of user's nautical (marketplace) orders.
User.nauticalOrders.filter ● CustomerNauticalOrderFilterInput input
User.nauticalOrders.sortBy ● OrderSortingInput input
User.nauticalOrders.before ● String scalar
Returns the items in the list that come before the specified cursor.
User.nauticalOrders.after ● String scalar
Returns the items in the list that come after the specified cursor.
User.nauticalOrders.first ● Int scalar
Returns the first n items from the list.
User.nauticalOrders.last ● Int scalar
Returns the items in the list that come after the specified cursor.
User.userPermissions ● [UserPermission!]! non-null object
List of user's permissions.
User.permissionGroups ● [Group!]! non-null object
List of user's permission groups.
User.editableGroups ● [Group!]! non-null object
List of user's permission groups which user can manage.
User.events ● [CustomerEvent!]! non-null object
List of events associated with the user.
User.storedPaymentSources ● [PaymentSource!]! non-null object
List of stored payment sources.
User.seller ● Seller object
The seller associated with this user.
User.wishlist ● WishlistItemCountableConnection! non-null object
Wishlist items of the user's default wishlist.
User.wishlist.before ● String scalar
Returns the items in the list that come before the specified cursor.
User.wishlist.after ● String scalar
Returns the items in the list that come after the specified cursor.
User.wishlist.first ● Int scalar
Returns the first n items from the list.
User.wishlist.last ● Int scalar
Returns the items in the list that come after the specified cursor.
User.wishlists ● WishlistCountableConnection! non-null object
All wishlists of the user.
User.wishlists.before ● String scalar
Returns the items in the list that come before the specified cursor.
User.wishlists.after ● String scalar
Returns the items in the list that come after the specified cursor.
User.wishlists.first ● Int scalar
Returns the first n items from the list.
User.wishlists.last ● Int scalar
Returns the items in the list that come after the specified cursor.
User.documents ● [Document!]! non-null object
List of documents associated with the user.
User.dashboardEmbeddingToken ● String scalar
Dashboard embedding token. If null, the environment isn't set or dashboard reporting is disabled.
User.customFields ● [SelectedAttribute!]! non-null object
List of custom fields assigned to this user.
Interfaces
Node interface
An object with a Globally Unique ID
ObjectWithMetadata interface
An object that supports metadata.
Returned By
me query ● user query ● userByEmail query
Member Of
AccountAddressCreate object ● AccountAddressDelete object ● AccountAddressSetDefault object ● AccountAddressUpdate object ● AccountConfirm object ● AccountDelete object ● AccountRegister object ● AccountRequestDeletion object ● AccountUpdate object ● AddressCreate object ● AddressDelete object ● AddressSetDefault object ● AddressUpdate object ● App object ● Checkout object ● Content object ● CustomerCreate object ● CustomerDelete object ● CustomerEvent object ● CustomerUpdate object ● EmailChangeConfirm object ● EmailChangeRequest object ● ExportEvent object ● ExportFile object ● Fulfillment object ● Group object ● ImportEvent object ● ImportFile object ● Ledger object ● NauticalOrder object ● NauticalOrderEvent object ● Order object ● OrderEvent object ● PasswordChange object ● PasswordRequestReset object ● PasswordSet object ● ProductStatusLog object ● Refund object ● Seller object ● SellerAgreementAcknowledge object ● SellerAgreementDecline object ● SellerEventType object ● SellerUserType object ● SSOLogin object ● StaffCreate object ● StaffDelete object ● StaffUpdate object ● StockEvent object ● TokenCreate object ● TokenCreateSSO object ● TokenRefresh object ● TokensDeactivateAll object ● TokenVerify object ● UserAvatarDelete object ● UserAvatarUpdate object ● UserCountableEdge object ● VendorPayoutEvent object ● Wishlist object
Implemented By
CustomFieldInstance union ● DocumentTargetInstance union ● Vendor union