INPUT_OBJECT
ShipmentCreateInput
link GraphQL Schema definition
1 input ShipmentCreateInput { 2 3 # Exactly one input field should be provided 4 : OrderInput! 5 6 : [ShipmentLineInput!]! 7 8 : Boolean 9 10 : Boolean 11 12 : DateTimeTz 13 14 # If this field is provided, it means shipment was already sent some time ago. 15 # In this case, most likely, the shipmentInfo input should be also populated 16 : DateTimeTz 17 18 # It is possible to set shipment info for a shipment that hasn't been sent yet. 19 # If the shipment was actually sent in the past, the shippedAt field should be also provided 20 : ShipmentInfoInput 21 22 # It will send a Shipping confirmation email to a customer. Only used if the shippedAt field is set 23 : Boolean 24 25 # shippingCostPolicy/handlingCostPolicy/discountValuePolicy are necessary when your order is split into multiple 26 # shipments. If the first shipment you created and captured contained the cost/value, you can use these policies 27 # to skip it in the subsequent shipments. 28 # This is needed because the payment providers will not allow you to capture more than was authorised, 29 # so you can only charge the cost once. 30 # Default value for all policies is "allRemaining". 31 # 32 # Exactly one input field should be provided 33 : CostPolicyInput 34 35 # Exactly one input field should be provided 36 : CostPolicyInput 37 38 # Exactly one input field should be provided 39 : CostPolicyInput 40 41 : String 42 43 : Boolean 44 45 # Exactly one input field should be provided 46 : ShipmentMethodInput 47 48 # Capturing real money, the whole shipment total. 49 # If capture fails, the shipment will still be created. The capture errors will be added to `userWarnings`, 50 # add them to a mutation payload. Read more about it here: 51 # https://centra.dev/docs/integration-api/example-queries-dtc#creating-and-capturing-a-shipment 52 # If the order was captured before and there is some amount not assigned to any shipment, it will be set to 53 # the new shipment. If the total shipment amount is assigned that way, no real capture will be made. 54 : Boolean 55 56 # Assign an external ID to reference this object by it later 57 : String 58 }