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

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

Order

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by