Skip to main content

ShipmentItemUpdateInput

Shipment item update data for modifying existing shipment item information.

Supports partial updates where only provided fields are modified, preserving existing values for omitted fields. Commonly used for adjusting quantities, updating product information, or correcting item details.

All fields from shipment item creation are available for updates including:

  • Quantity adjustments (must not exceed remaining order item quantities)
  • Product information updates (name, SKU corrections)
  • Shipment association changes (moving items between shipments)

Validation ensures that updated quantities do not exceed available order item quantities.

input ShipmentItemUpdateInput {
  orderItemId: Int
  quantity: Int
  name: String
  sku: String
  shipmentId: String
}

Fields​

ShipmentItemUpdateInput.orderItemId ● Int scalar​

Reference to the original order item that this shipment item fulfills.

Links the shipped item back to the customer's original order for tracking and customer service.

ShipmentItemUpdateInput.quantity ● Int scalar​

Number of units to include in the shipment item.

Must be a positive integer and cannot exceed the remaining unfulfilled quantity from the original order item.

ShipmentItemUpdateInput.name ● String scalar​

Descriptive name for the shipment item.

Provides human-readable identification of the product being shipped for fulfillment and tracking purposes.

ShipmentItemUpdateInput.sku ● String scalar​

Stock Keeping Unit code for the shipment item.

Unique product identifier used for inventory tracking and product identification throughout the fulfillment process.

ShipmentItemUpdateInput.shipmentId ● String scalar​

Unique UUID identifier for the shipment.

This identifier is used to track and reference the shipment throughout its lifecycle from creation to delivery.

Member Of​

shipmentItemUpdate mutation