INTERFACE

Order

GraphQL Schema definition

1 interface Order {
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): [EmailHistoryEntry!]! 
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): [OrderHistoryEntry!]! 
78 
79 #   Required permission: none
80 language: 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 #   Store restrictions apply.
89 # 
90 # Arguments
91 #   includeFullyCancelled: (self-explanatory)
92 #   limit: (self-explanatory)
93 #   page: (self-explanatory)
94 lines(includeFullyCancelled: Boolean = false, limit: Int, page: Int = 1): [OrderLine!]! 
95 
96 #   Required permission: Market:read
97 # 
98 #   Store restrictions apply.
99 market: Market 
100 
101 #   Required permission: Order:read
102 # 
103 #   All elements are always returned
104 orderDocuments: [OrderDocument!]! 
105 
106 #   Required permission: StorePlugin:read
107 # 
108 #   Store restrictions apply.
109 paymentMethod: StorePlugin 
110 
111 #   Required permission: PaymentHistory:read
112 # 
113 #   Limit must be in range 1 - 200
114 # 
115 #   Store restrictions apply.
116 # 
117 # Arguments
118 #   where: (self-explanatory)
119 #   sort: (self-explanatory)
120 #   limit: (self-explanatory)
121 #   page: (self-explanatory)
122 paymentHistory(where: PaymentHistoryEntryFilter, sort: [PaymentHistoryEntrySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PaymentHistoryEntry!]! 
123 
124 #   Required permission: Pricelist:read
125 # 
126 #   Store restrictions apply.
127 pricelist: Pricelist! 
128 
129 #   Required permission: Return:read
130 # 
131 #   All elements are always returned
132 # 
133 #   Store restrictions apply.
134 returns: [Return!]! 
135 
136 #   Required permission: Shipment:read
137 # 
138 #   All elements are always returned
139 # 
140 #   Store restrictions apply.
141 shipments: [Shipment!]! 
142 
143 #   Required permission: Order.shippingAddress:read
144 shippingAddress: Address 
145 
146 #   Required permission: ShippingOption:read
147 shippingPriceGroup: ShippingPriceGroup 
148 
149 #   Required permission: none
150 state: CountryState 
151 
152 #   Required permission: Store:read
153 # 
154 #   Store restrictions apply.
155 store: Store! 
156 
157 #   Required permission: Order:read
158 totals: OrderTotals! 
159 
160 #   All elements are always returned
161 taxBreakdown: [TaxBreakdownLine!]! 
162 
163 #   Required permission: AllocationRule:read
164 allocationRule: AllocationRule 
165 
166 isLocked: Boolean! 
167 
168 isOnHold: Boolean! 
169 
170 isWaitingForCheckFirstAllocation: Boolean! 
171 
172 isWaitingForPayment: Boolean! 
173 
174 isInternal: Boolean! 
175 
176 hasPendingAllocationRequests: Boolean! 
177 
178 usedFallbackTax: Boolean! 
179 
180 # Arguments
181 #   includeWaitingForConfirmation: (self-explanatory)
182 allocatedWarehouseCount(includeWaitingForConfirmation: Boolean! = true): Int! 
183 
184 externalId: String 
185 
186 }

1	interface Order {
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): [EmailHistoryEntry!]!
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): [OrderHistoryEntry!]!
78
79	# Required permission: none
80	language: 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	# Store restrictions apply.
89	#
90	# Arguments
91	# includeFullyCancelled: (self-explanatory)
92	# limit: (self-explanatory)
93	# page: (self-explanatory)
94	lines(includeFullyCancelled: Boolean = false, limit: Int, page: Int = 1): [OrderLine!]!
95
96	# Required permission: Market:read
97	#
98	# Store restrictions apply.
99	market: Market
100
101	# Required permission: Order:read
102	#
103	# All elements are always returned
104	orderDocuments: [OrderDocument!]!
105
106	# Required permission: StorePlugin:read
107	#
108	# Store restrictions apply.
109	paymentMethod: StorePlugin
110
111	# Required permission: PaymentHistory:read
112	#
113	# Limit must be in range 1 - 200
114	#
115	# Store restrictions apply.
116	#
117	# Arguments
118	# where: (self-explanatory)
119	# sort: (self-explanatory)
120	# limit: (self-explanatory)
121	# page: (self-explanatory)
122	paymentHistory(where: PaymentHistoryEntryFilter, sort: [PaymentHistoryEntrySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [PaymentHistoryEntry!]!
123
124	# Required permission: Pricelist:read
125	#
126	# Store restrictions apply.
127	pricelist: Pricelist!
128
129	# Required permission: Return:read
130	#
131	# All elements are always returned
132	#
133	# Store restrictions apply.
134	returns: [Return!]!
135
136	# Required permission: Shipment:read
137	#
138	# All elements are always returned
139	#
140	# Store restrictions apply.
141	shipments: [Shipment!]!
142
143	# Required permission: Order.shippingAddress:read
144	shippingAddress: Address
145
146	# Required permission: ShippingOption:read
147	shippingPriceGroup: ShippingPriceGroup
148
149	# Required permission: none
150	state: CountryState
151
152	# Required permission: Store:read
153	#
154	# Store restrictions apply.
155	store: Store!
156
157	# Required permission: Order:read
158	totals: OrderTotals!
159
160	# All elements are always returned
161	taxBreakdown: [TaxBreakdownLine!]!
162
163	# Required permission: AllocationRule:read
164	allocationRule: AllocationRule
165
166	isLocked: Boolean!
167
168	isOnHold: Boolean!
169
170	isWaitingForCheckFirstAllocation: Boolean!
171
172	isWaitingForPayment: Boolean!
173
174	isInternal: Boolean!
175
176	hasPendingAllocationRequests: Boolean!
177
178	usedFallbackTax: Boolean!
179
180	# Arguments
181	# includeWaitingForConfirmation: (self-explanatory)
182	allocatedWarehouseCount(includeWaitingForConfirmation: Boolean! = true): Int!
183
184	externalId: String
185
186	}

Order

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by