OBJECT

DirectToConsumerOrder

GraphQL Schema definition

1 type DirectToConsumerOrder implements Order, ObjectWithAttributes {
2 id: String! 
3 
4 number: Int! 
5 
6 status: OrderStatus! 
7 
8 # Arguments
9 #   includingTax: (self-explanatory)
10 grandTotal(includingTax: Boolean! = true): MonetaryValue! 
11 
12 #   Same as orderDate
13 # 
14 # Arguments
15 #   format: ISO-8601
16 createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz! 
17 
18 # Arguments
19 #   format: ISO-8601
20 updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz! 
21 
22 #   Same as createdAt
23 # 
24 # Arguments
25 #   format: ISO-8601
26 orderDate(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz! 
27 
28 #   Required permission: Order.userIP:read
29 userIP: String 
30 
31 #   Required permission: Order.internalComment:read
32 internalComment: String 
33 
34 otherComment: String! 
35 
36 currencyBaseRate: Float! 
37 
38 #   Required permission: Order.attributes:read
39 # 
40 #   All elements are always returned
41 # 
42 # Arguments
43 #   where: (self-explanatory)
44 attributes(where: AssignedAttributeFilter): [Attribute!]! 
45 
46 #   Required permission: Order.billingAddress:read
47 billingAddress: Address 
48 
49 #   Required permission: none
50 country: Country 
51 
52 #   Required permission: Order:read
53 # 
54 #   All elements are always returned
55 discountsApplied: [OrderDiscount!]! 
56 
57 #   Required permission: EmailHistory:read
58 # 
59 #   Limit must be in range 1 - 200
60 # 
61 # Arguments
62 #   where: (self-explanatory)
63 #   sort: (self-explanatory)
64 #   limit: (self-explanatory)
65 #   page: (self-explanatory)
66 emailHistory(where: EmailHistoryFilter, sort: [EmailHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerEmailHistoryEntry!]! 
67 
68 #   Required permission: OrderHistory:read
69 # 
70 #   Limit must be in range 1 - 200
71 # 
72 # Arguments
73 #   where: (self-explanatory)
74 #   sort: (self-explanatory)
75 #   limit: (self-explanatory)
76 #   page: (self-explanatory)
77 history(where: OrderHistoryFilter, sort: [OrderHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerOrderHistoryEntry!]! 
78 
79 #   Required permission: none
80 language: Language 
81 
82 #   Required permission: Order:read
83 # 
84 #   All elements are always returned
85 # 
86 # Arguments
87 #   includeFullyCancelled: (self-explanatory)
88 lines(includeFullyCancelled: Boolean = false): [OrderLine!]! 
89 
90 #   Required permission: Market:read
91 # 
92 #   Store restrictions apply.
93 market: Market 
94 
95 #   Required permission: Order:read
96 # 
97 #   All elements are always returned
98 orderDocuments: [OrderDocument!]! 
99 
100 #   Required permission: StorePlugin:read
101 # 
102 #   Store restrictions apply.
103 paymentMethod: StorePlugin 
104 
105 #   Required permission: PaymentHistory:read
106 # 
107 #   Limit must be in range 1 - 200
108 # 
109 # Arguments
110 #   where: (self-explanatory)
111 #   sort: (self-explanatory)
112 #   limit: (self-explanatory)
113 #   page: (self-explanatory)
114 paymentHistory(where: PaymentHistoryEntryFilter, sort: [PaymentHistoryEntrySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PaymentHistoryEntry!]! 
115 
116 #   Required permission: Pricelist:read
117 # 
118 #   Store restrictions apply.
119 pricelist: Pricelist! 
120 
121 #   Required permission: Return:read
122 # 
123 #   All elements are always returned
124 # 
125 #   Store restrictions apply.
126 returns: [DirectToConsumerReturn!]! 
127 
128 #   Required permission: Shipment:read
129 # 
130 #   All elements are always returned
131 # 
132 #   Store restrictions apply.
133 shipments: [DirectToConsumerShipment!]! 
134 
135 #   Required permission: Order.shippingAddress:read
136 shippingAddress: Address 
137 
138 #   Required permission: ShippingOption:read
139 # 
140 #   Store restrictions apply.
141 shippingPriceGroup: ShippingPriceGroup 
142 
143 #   Required permission: none
144 state: CountryState 
145 
146 #   Required permission: Store:read
147 # 
148 #   Store restrictions apply.
149 store: Store! 
150 
151 #   Required permission: Order:read
152 totals: OrderTotals! 
153 
154 #   All elements are always returned
155 taxBreakdown: [TaxBreakdownLine!]! 
156 
157 #   Required permission: AllocationRule:read
158 allocationRule: AllocationRule 
159 
160 customerInfo: CustomerInfo! 
161 
162 isLocked: Boolean! 
163 
164 isOnHold: Boolean! 
165 
166 isWaitingForPayment: Boolean! 
167 
168 isInternal: Boolean! 
169 
170 #   Required permission: Affiliate:read
171 # 
172 #   Store restrictions apply.
173 affiliate: Affiliate 
174 
175 #   Required permission: Customer:read
176 # 
177 #   Store restrictions apply.
178 customer: Customer 
179 
180 }

1	type DirectToConsumerOrder implements Order, ObjectWithAttributes {
2	id: String!
3
4	number: Int!
5
6	status: OrderStatus!
7
8	# Arguments
9	# includingTax: (self-explanatory)
10	grandTotal(includingTax: Boolean! = true): MonetaryValue!
11
12	# Same as orderDate
13	#
14	# Arguments
15	# format: ISO-8601
16	createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
17
18	# Arguments
19	# format: ISO-8601
20	updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
21
22	# Same as createdAt
23	#
24	# Arguments
25	# format: ISO-8601
26	orderDate(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
27
28	# Required permission: Order.userIP:read
29	userIP: String
30
31	# Required permission: Order.internalComment:read
32	internalComment: String
33
34	otherComment: String!
35
36	currencyBaseRate: Float!
37
38	# Required permission: Order.attributes:read
39	#
40	# All elements are always returned
41	#
42	# Arguments
43	# where: (self-explanatory)
44	attributes(where: AssignedAttributeFilter): [Attribute!]!
45
46	# Required permission: Order.billingAddress:read
47	billingAddress: Address
48
49	# Required permission: none
50	country: Country
51
52	# Required permission: Order:read
53	#
54	# All elements are always returned
55	discountsApplied: [OrderDiscount!]!
56
57	# Required permission: EmailHistory:read
58	#
59	# Limit must be in range 1 - 200
60	#
61	# Arguments
62	# where: (self-explanatory)
63	# sort: (self-explanatory)
64	# limit: (self-explanatory)
65	# page: (self-explanatory)
66	emailHistory(where: EmailHistoryFilter, sort: [EmailHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerEmailHistoryEntry!]!
67
68	# Required permission: OrderHistory:read
69	#
70	# Limit must be in range 1 - 200
71	#
72	# Arguments
73	# where: (self-explanatory)
74	# sort: (self-explanatory)
75	# limit: (self-explanatory)
76	# page: (self-explanatory)
77	history(where: OrderHistoryFilter, sort: [OrderHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [DirectToConsumerOrderHistoryEntry!]!
78
79	# Required permission: none
80	language: Language
81
82	# Required permission: Order:read
83	#
84	# All elements are always returned
85	#
86	# Arguments
87	# includeFullyCancelled: (self-explanatory)
88	lines(includeFullyCancelled: Boolean = false): [OrderLine!]!
89
90	# Required permission: Market:read
91	#
92	# Store restrictions apply.
93	market: Market
94
95	# Required permission: Order:read
96	#
97	# All elements are always returned
98	orderDocuments: [OrderDocument!]!
99
100	# Required permission: StorePlugin:read
101	#
102	# Store restrictions apply.
103	paymentMethod: StorePlugin
104
105	# Required permission: PaymentHistory:read
106	#
107	# Limit must be in range 1 - 200
108	#
109	# Arguments
110	# where: (self-explanatory)
111	# sort: (self-explanatory)
112	# limit: (self-explanatory)
113	# page: (self-explanatory)
114	paymentHistory(where: PaymentHistoryEntryFilter, sort: [PaymentHistoryEntrySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PaymentHistoryEntry!]!
115
116	# Required permission: Pricelist:read
117	#
118	# Store restrictions apply.
119	pricelist: Pricelist!
120
121	# Required permission: Return:read
122	#
123	# All elements are always returned
124	#
125	# Store restrictions apply.
126	returns: [DirectToConsumerReturn!]!
127
128	# Required permission: Shipment:read
129	#
130	# All elements are always returned
131	#
132	# Store restrictions apply.
133	shipments: [DirectToConsumerShipment!]!
134
135	# Required permission: Order.shippingAddress:read
136	shippingAddress: Address
137
138	# Required permission: ShippingOption:read
139	#
140	# Store restrictions apply.
141	shippingPriceGroup: ShippingPriceGroup
142
143	# Required permission: none
144	state: CountryState
145
146	# Required permission: Store:read
147	#
148	# Store restrictions apply.
149	store: Store!
150
151	# Required permission: Order:read
152	totals: OrderTotals!
153
154	# All elements are always returned
155	taxBreakdown: [TaxBreakdownLine!]!
156
157	# Required permission: AllocationRule:read
158	allocationRule: AllocationRule
159
160	customerInfo: CustomerInfo!
161
162	isLocked: Boolean!
163
164	isOnHold: Boolean!
165
166	isWaitingForPayment: Boolean!
167
168	isInternal: Boolean!
169
170	# Required permission: Affiliate:read
171	#
172	# Store restrictions apply.
173	affiliate: Affiliate
174
175	# Required permission: Customer:read
176	#
177	# Store restrictions apply.
178	customer: Customer
179
180	}

DirectToConsumerOrder

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by