OBJECT

Shipment

link GraphQL Schema definition

1type Shipment {
2id: Int!
3
4number: String!
5
6# Arguments
7# format: ISO-8601
8createdAt(format: String = "Y-m-d\\TH:i:sP"): String!
9
10# Arguments
11# format: ISO-8601
12updatedAt(format: String = "Y-m-d\\TH:i:sP"): String!
13
14isGoodToGo: Boolean!
15
16isPrinted: Boolean!
17
18isShipped: Boolean!
19
20isOnHold: Boolean!
21
22consignationWarehouseStatus: ConsignationWarehouseStatus!
23
24trackingNumber: String
25
26returnTrackingNumber: String
27
28numberOfPackages: Int!
29
30# Arguments
31# includingTax: (self-explanatory)
32grandTotal(includingTax: Boolean! = true): MonetaryValue!
33
34additionalMessage: String
35
36# Arguments
37# format: ISO-8601
38emailSentAt(format: String = "Y-m-d\\TH:i:sP"): String
39
40isPaid: Boolean!
41
42# Arguments
43# format: ISO-8601
44paidAt(format: String = "Y-m-d\\TH:i:sP"): String
45
46# Required permission: AdminUser:read
47adminUser: AdminUser
48
49carrierInformation: CarrierInformation
50
51# Required permission: Order:read
52#
53# All elements are always returned
54discountsApplied: [OrderDiscount!]!
55
56# Required permission: Invoice:read
57#
58# All elements are always returned
59#
60# Store restrictions apply.
61invoices: [Invoice!]!
62
63# Required permission: none
64#
65# All elements are always returned
66lines: [ShipmentLine!]!
67
68# Required permission: Order:read
69#
70# Store restrictions apply.
71order: Order!
72
73# Required permission: Return:read
74#
75# All elements are always returned
76#
77# Store restrictions apply.
78returns: [Return!]!
79
80# Required permission: Shipment.shippingAddress:read
81shippingAddress: Address
82
83# Required permission: StorePlugin:read
84#
85# Store restrictions apply.
86shipmentPlugin: StorePlugin
87
88# Required permission: Store:read
89#
90# Store restrictions apply.
91store: Store!
92
93# Required permission: Shipment:read
94totals: ShipmentTotals!
95
96}