Skip to main content

ShipmentWarning

A warning about an accepted shipment write, such as an order item shipped beyond its ordered quantity

type ShipmentWarning {
  code: ShipmentWarningCode!
  orderItemId: Int!
  orderedQuantity: Float!
  shippedQuantity: Float!
}

Fields​

ShipmentWarning.code ● ShipmentWarningCode! non-null enum​

What the warning is about.

ShipmentWarning.orderItemId ● Int! non-null scalar​

The order item the warning is about.

ShipmentWarning.orderedQuantity ● Float! non-null scalar​

The quantity ordered on the order item.

ShipmentWarning.shippedQuantity ● Float! non-null scalar​

The order item's quantity summed over all of its dispatched shipments -- those with no status, or a status that means the parcel has left -- after this write.

Member Of​

Shipment object ● ShipmentItem object