OBJECT

DirectToConsumerOrder

link GraphQL Schema definition

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