INTERFACE

Return

link GraphQL Schema definition

1interface Return {
2id: Int!
3
4status: Status!
5
6# Arguments
7# format: ISO-8601
8createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
9
10totalQuantity: Int!
11
12# Arguments
13# includingTax: (self-explanatory)
14grandTotal(includingTax: Boolean = true): MonetaryValue!
15
16returnedToStock: Boolean!
17
18# Required permission: Return.comment:read
19comment: String
20
21createdFrom: String
22
23currencyBaseRate: Float!
24
25# Required permission: AdminUser:read
26adminUser: AdminUser
27
28# Required permission: Order:read
29#
30# All elements are always returned
31discountsApplied: [OrderDiscount!]!
32
33# Required permission: none
34#
35# All elements are always returned
36lines: [ReturnLine!]!
37
38# Required permission: Warehouse:read
39returnWarehouse: Warehouse
40
41# Required permission: Store:read
42#
43# Store restrictions apply.
44store: Store!
45
46# Required permission: Return:read
47totals: ReturnTotals!
48
49# Required permission: Order:read
50#
51# Store restrictions apply.
52order: Order!
53
54# Required permission: Shipment:read
55#
56# Store restrictions apply.
57shipment: Shipment!
58
59}