ShippingShipmentInput

Details about the shipment, including weight, dimensions, order value, and attributes that affect shipping option availability and pricing

input ShippingShipmentInput {
  weight: Int
  dimensions: ShippingDimensionsInput
  volume: Int
  orderValue: PriceInput
  items: [ShippingItemInput]
  attributes: ShippingShipmentAttributesInput
  tags: [String!]
  freeShipping: Boolean
  fulfillmentInfo: ShippingFulfillmentInfoInput!
}

Fields

`weight` ● `Int`

Weight in grams (g) — used if provided, else calculated from items

`dimensions` ● `ShippingDimensionsInput`

Dimensions of the package/shipment in centimeters (length, width, height in cm). IMPORTANT: This is NOT automatically calculated from items. Must be explicitly provided if required by carriers. Some carriers may require this for accurate shipping calculations.

`volume` ● `Int`

Volume in cubic centimeters (cm³) — used if provided, else calculated from items

`orderValue` ● `PriceInput`

Order value (total of all items). Optional — if not provided, will be calculated by summing item prices × quantities.

`items` ● `[ShippingItemInput]`

Individual items in the shipment. If provided, missing shipment-level values are automatically calculated:

weight: summed from item weights × quantities
volume: summed from item volumes × quantities (or calculated from dimensions)
orderValue: summed from item prices × quantities

NOTE: Shipment dimensions are NOT calculated from items — must be provided explicitly if required.

`attributes` ● `ShippingShipmentAttributesInput`

Shipment characteristics that affect available options and pricing

`tags` ● `[String!]`

Custom tags for internal use or carrier-specific metadata

`freeShipping` ● `Boolean`

If true, some returned shipping options, including freeShipping campaigns, will have price set to zero (free shipping). This could be set by the client if a campaign, discount code, or other logic grants free shipping for this order.

`fulfillmentInfo` ● `ShippingFulfillmentInfoInput!`

Stock availability and fulfillment timing for this shipment.

Example

{
  "dimensions": {},
  "orderValue": {},
  "items": [
    {
      "attributes": [
        {}
      ]
    }
  ],
  "attributes": {},
  "fulfillmentInfo": {
    "inStockDateTime": "2024-05-03T11:52:33Z"
  }
}

Fields​

weight ● Int​

dimensions ● ShippingDimensionsInput​

volume ● Int​

orderValue ● PriceInput​

items ● [ShippingItemInput]​

attributes ● ShippingShipmentAttributesInput​

tags ● [String!]​

freeShipping ● Boolean​

fulfillmentInfo ● ShippingFulfillmentInfoInput!​

Example​