INPUT_OBJECT

ShipmentUpdateInput

link GraphQL Schema definition

1input ShipmentUpdateInput {
2
3# It is possible to set shipment info for a shipment that hasn't been sent yet.
4# If the shipment was actually sent in the past, use the completeShipment mutation.
5shipmentInfo: ShipmentInfoInput
6
7additionalMessage: String
8
9isGoodToGo: Boolean
10
11# Provide `isPaid: true` only if the shipment was captured outside Centra or no capturing is expected for it.
12# It doesn't perform capturing, use the `captureShipment` mutation for it.
13# If the `captureShipment` mutation is used, there is no need to update the shipment with `isPaid: true` as
14# the mutation will mark the shipment as paid based on the capture results.
15isPaid: Boolean
16
17# If not provided, it will be the full shipment amount.
18paidValue: MonetaryValueInput
19
20# It isn't possible to update shipment method, shipment info or isGoodToGo fields
21# if the shipment was already shipped.
22#
23# Exactly one input field should be provided
24shipmentMethod: ShipmentMethodInput
25
26# Assign an external ID to reference this object by it later
27externalId: String
28}

link Required by