INTERFACE

Order

link GraphQL Schema definition

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