INPUT_OBJECT

ShipmentCreateInput

link GraphQL Schema definition

1input ShipmentCreateInput {
2
3# Exactly one input field should be provided
4order: OrderInput!
5
6lines: [ShipmentLineInput!]!
7
8isGoodToGo: Boolean
9
10isPaid: Boolean
11
12createdAt: 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
16shippedAt: 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
20shipmentInfo: ShipmentInfoInput
21
22# It will send a Shipping confirmation email to a customer. Only used if the shippedAt field is set
23sendEmail: 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
33shippingCostPolicy: CostPolicyInput
34
35# Exactly one input field should be provided
36handlingCostPolicy: CostPolicyInput
37
38# Exactly one input field should be provided
39discountValuePolicy: CostPolicyInput
40
41additionalMessage: String
42
43allocateDemand: Boolean
44
45# Exactly one input field should be provided
46shipmentMethod: 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://docs.centra.com/api-references/graphql-integration-api/examples/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.
54capture: Boolean
55
56# Assign an external ID to reference this object by it later
57externalId: String
58}

link Required by