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

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

Order

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by