OBJECT

Customer

link GraphQL Schema definition

1type Customer implements ObjectWithAttributes {
2id: Int!
3
4status: Status!
5
6email: String!
7
8firstName: String
9
10lastName: String
11
12cellPhoneNumber: String
13
14phoneNumber: String
15
16# Arguments
17# format: ISO-8601
18createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
19
20# Arguments
21# format: ISO-8601
22updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
23
24# Arguments
25# format: ISO-8601
26lastLoginAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
27
28# Arguments
29# format: ISO-8601
30lastOnlineAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
31
32# Required permission: Customer.totalOrders:read
33totalOrders: Int!
34
35# Required permission: Customer.billingAddress:read
36billingAddress: Address
37
38# Required permission: EmailHistory:read
39#
40# Limit must be in range 1 - 200
41#
42# Arguments
43# where: (self-explanatory)
44# sort: (self-explanatory)
45# limit: (self-explanatory)
46# page: (self-explanatory)
47emailHistory(where: EmailHistoryFilter, sort: [EmailHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerEmailHistoryEntry!]!
48
49# Required permission: Store:read
50#
51# Store restrictions apply.
52store: Store!
53
54# Arguments
55# format: (self-explanatory)
56birthdate(format: String = "Y-m-d"): Date
57
58isAnonymized: Boolean!
59
60isRegistered: Boolean!
61
62websiteUrl: String
63
64internalComment: String
65
66gender: Gender
67
68# Required permission: Customer.attributes:read
69#
70# All elements are always returned
71#
72# Arguments
73# where: (self-explanatory)
74attributes(where: AssignedAttributeFilter): [Attribute!]!
75
76# Required permission: none
77language: Language
78
79# Required permission: Order:read
80#
81# Store restrictions apply.
82lastOrder: DirectToConsumerOrder
83
84# Required permission: Market:read
85#
86# Store restrictions apply.
87market: Market
88
89# Required permission: NewsletterSubscription:read
90#
91# All elements are always returned
92#
93# Store restrictions apply.
94newsletterSubscriptions: [NewsletterSubscription!]!
95
96# Required permission: Order:read
97#
98# Limit must be in range 1 - 100
99#
100# Store restrictions apply.
101#
102# Arguments
103# where: (self-explanatory)
104# sort: (self-explanatory)
105# limit: (self-explanatory)
106# page: (self-explanatory)
107orders(where: OrderFilter, sort: [OrderSort!] = [number_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerOrder!]!
108
109# Required permission: Pricelist:read
110#
111# Store restrictions apply.
112pricelist: Pricelist
113
114# Required permission: Return:read
115#
116# Limit must be in range 1 - 100
117#
118# Store restrictions apply.
119#
120# Arguments
121# where: (self-explanatory)
122# sort: (self-explanatory)
123# limit: (self-explanatory)
124# page: (self-explanatory)
125returns(where: ReturnFilter, sort: [ReturnSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerReturn!]!
126
127# Required permission: TaxClass:read
128taxClass: TaxClass
129
130# Required permission: Wishlist:read
131#
132# Limit must be in range 1 - 100
133#
134# Store restrictions apply.
135#
136# Arguments
137# where: (self-explanatory)
138# sort: (self-explanatory)
139# limit: (self-explanatory)
140# page: (self-explanatory)
141wishlists(where: WishlistFilter, sort: [WishlistSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Wishlist!]!
142
143externalId: String
144
145}