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
58# Required permission: AdminUser:read
59adminUser: AdminUser
60
61carrierInformation: CarrierInformation
62
63# Required permission: Order:read
64#
65# All elements are always returned
66discountsApplied: [OrderDiscount!]!
67
68# Required permission: none
69#
70# All elements are always returned
71lines: [ShipmentLine!]!
72
73# Required permission: Shipment.shippingAddress:read
74shippingAddress: Address
75
76# Required permission: StorePlugin:read
77#
78# Store restrictions apply.
79shipmentPlugin: StorePlugin
80
81# Required permission: Store:read
82#
83# Store restrictions apply.
84store: Store!
85
86# Required permission: Shipment:read
87totals: ShipmentTotals!
88
89externalId: String
90
91# Required permission: Invoice:read
92#
93# All elements are always returned
94#
95# Store restrictions apply.
96invoices: [DirectToConsumerInvoice!]!
97
98# Required permission: Order:read
99#
100# Store restrictions apply.
101order: DirectToConsumerOrder!
102
103# Required permission: Return:read
104#
105# All elements are always returned
106#
107# Store restrictions apply.
108returns: [DirectToConsumerReturn!]!
109
110}