ShipmentCreateWorkflowInput

Input.

No description

Fields

bookingNumber

•

String

The booking number for freight shipments

contentsType

•

ShipmentContentsType

The type of contents in the shipment package

declaredValue

•

Decimal

The declared value (insurance) of the shipment

declaredValueCurrencyCode

•

CurrencyCode

When set with declaredValue, the declared value is the explicit amount supplied here, capped at the order's item subtotal in this currency (read from amountSubtotalsDetails); no cap is applied when the order has no item subtotal in this currency. When omitted, the legacy behavior applies (declared value computed from the order's items).

exemption

•

String

Exemption code for shipments requiring an ITN

externalAccountNumber

•

String

Optional Japan Post deferred-payment (later-pay) customer number, in the hyphen-formatted form NNNNNNNNNN-NNNNNN-NNNNNNNNNN-NNNNNN. When provided for a standalone Japan Post shipment, overrides the automatic LATER_PAY_NUMBER lookup. Ignored for other carriers and for shipments that are part of a ShipmentConsolidation.

fulfilledItemIds

•

[String!]

IDs of fulfilled order items. When provided, only cartons where all items are fulfilled will have labels generated. Used for partial kit fulfillment.

fulfillmentCenter

•

Optional ID of the FulfillmentCenter this Shipment is being fulfilled from.

generateCustoms

•

Boolean

Boolean value to indicate if a CustomSpec should be generated from this Shipment

generateLabel

•

Boolean

Boolean value to indicate if a Label should be generated for the ShipmentCarton(s) in this Shipment

generatePackingSlip

•

Boolean

Boolean value to indicate if a PackingSlip should be generated for this Shipment

isDeclaredValue

•

Boolean

The declared value (insurance) of the shipment

itnNumber

•

String

ITN to apply on the label request

labelSpec

•

LabelSpecInput

The optional label specifications for the Label to be generated

nonDelivery

•

ShipmentNonDeliveryInput

Instructions for handling non-deliverable shipments

orderId

•

ID or accountOrderNumber of the Order this Shipment will belong to. Required if no Party or Carton objects are present.

references

•

ShipmentReferenceInput

Optional references to be added on the Label and CI

serviceLevel

•

String

ID or code of the ServiceLevel to be used for this Shipment.

shipmentCartonSpecialServices

•

ShipmentCartonSpecialServiceDetailInput

Special service details to apply at the ShipmentCarton level

shipmentCartons

•

[ShipmentCartonInput!]

Optional field to specify ShipmentCarton objects associated with the Shipment.

shipmentConsolidationId

•

ID of the ShipmentConsolidation this Shipment will belong to

shipmentDate

•

DateTime

A specified date for a future shipment

shipmentDeclarationStatement

•

String

Custom declaration statement for this shipment, takes priority over org-level settings

specialInstructions

•

String

Any special instructions related to this Shipment

specialServices

•

[ShipmentSpecialService!]

A list of ShipmentSpecialServices to apply to this Shipment

trackingNumber

•

String

The optional tracking number related to the shipment

trackingNumbers

•

[String!]

Tracking numbers associated with this Shipment

Input.