Input.

ShipmentCartonInput

No description

Fields

declaredValue

•

Decimal

The declared value (carrier insurance) for this specific carton/package. Takes priority over the shipment-level declared value and is only forwarded to the carrier when isDeclaredValue is true.

dimensionalUnit

•

DimensionalUnitCode!

Required

The measurement units of the height, length and width for the ShipmentCarton's Carton

height

•

Decimal

The numeric height of the ShipmentCarton.

isDeclaredValue

•

Boolean

Whether the contents value of this carton is being declared for carrier insurance purposes.

items

•

[ShipmentCartonItemInput!]

The list of Items included in this ShipmentCarton. Optional when providing cartons purely for packaging type information.

length

•

Decimal

The numeric length of the ShipmentCarton.

packagingType

•

ShipmentPackagingTypeCode

Optional type of packaging being used for the packages in the shipment. If not provided, will default to the carrier default.

specialServiceDetails

•

ShipmentCartonSpecialServiceDetailInput

Input field including details for all special services required at the package level

specialServices

•

[ShipmentCartonSpecialService!]

A list of ShipmentCartonSpecialServices that apply to this ShipmentCarton

trackingNumber

•

String

The tracking number for this specific Carton, if different than the tracking number for the entire Shipment

weight

•

Decimal

The weight of the ShipmentCarton.

weightUnit

•

WeightUnitCode!

Required

The type of weight associated with the ShipmentCarton.

width

•

Decimal

The numeric width of the ShipmentCarton.

Fields

Was this page helpful?