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