OBJECT

DirectToConsumerShipment

link GraphQL Schema definition

1type DirectToConsumerShipment implements Shipment {
2id: Int!
3
4number: String!
5
6# Arguments
7# format: ISO-8601
8createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
9
10# Arguments
11# format: ISO-8601
12updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
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
30internalShippingCost: MonetaryValue
31
32# Arguments
33# includingTax: (self-explanatory)
34grandTotal(includingTax: Boolean! = true): MonetaryValue!
35
36additionalMessage: String
37
38# Arguments
39# format: ISO-8601
40shippedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
41
42isPaid: Boolean!
43
44# Arguments
45# format: ISO-8601
46paidAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
47
48isCaptured: Boolean!
49
50# Arguments
51# format: ISO-8601
52capturedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz
53
54capturedValue: MonetaryValue
55
56currencyBaseRate: Float!
57
58usedFallbackTax: Boolean!
59
60# Required permission: AdminUser:read
61adminUser: AdminUser
62
63carrierInformation: CarrierInformation
64
65# Required permission: Order:read
66#
67# All elements are always returned
68discountsApplied: [OrderDiscount!]!
69
70# Required permission: none
71#
72# All elements are always returned
73lines: [ShipmentLine!]!
74
75# Required permission: Shipment.shippingAddress:read
76shippingAddress: Address
77
78# Required permission: StorePlugin:read
79#
80# Store restrictions apply.
81shipmentPlugin: StorePlugin
82
83# Required permission: Store:read
84#
85# Store restrictions apply.
86store: Store!
87
88# Required permission: Shipment:read
89totals: ShipmentTotals!
90
91externalId: String
92
93# Required permission: Invoice:read
94#
95# All elements are always returned
96#
97# Store restrictions apply.
98invoices: [DirectToConsumerInvoice!]!
99
100# Required permission: Order:read
101#
102# Store restrictions apply.
103order: DirectToConsumerOrder!
104
105# Required permission: DeliveryGroup:read
106#
107# Store restrictions apply.
108deliveryGroup: DeliveryGroup
109
110# Required permission: Return:read
111#
112# All elements are always returned
113#
114# Store restrictions apply.
115returns: [DirectToConsumerReturn!]!
116
117}