Skip to main content

ShipmentItem

Individual item within a shipment representing a specific product and quantity being fulfilled from an order

type ShipmentItem {
  id: String!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  name: String
  sku: String
  quantity: Int
  shipmentId: String!
  orderItemId: Int
  warnings: [ShipmentWarning!]
  orderItem: OrderItem
}

Fields​

ShipmentItem.id ● String! non-null scalar​

Unique UUID identifier for the individual shipment item.

Used to track specific items within a shipment for inventory and fulfillment purposes.

ShipmentItem.createdAt ● DateTime! non-null scalar​

Timestamp when the shipment item was added to the shipment.

Used for tracking item processing and fulfillment timelines.

ShipmentItem.lastModifiedAt ● DateTime! non-null scalar​

Timestamp of the most recent update to the shipment item.

Reflects when item details such as quantity or status were last modified.

ShipmentItem.name ● String scalar​

Descriptive name of the product being shipped.

Provides human-readable identification of the item for fulfillment and customer communication.

ShipmentItem.sku ● String scalar​

Product SKU

ShipmentItem.quantity ● Int scalar​

Number of units of this product included in the shipment.

May be less than the original order quantity if the order is fulfilled across multiple shipments.

ShipmentItem.shipmentId ● String! non-null scalar​

Reference to the parent shipment being tracked.

Links the tracking information to the specific shipment for comprehensive delivery monitoring.

ShipmentItem.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.

ShipmentItem.warnings ● [ShipmentWarning!] list object​

Warnings about this write, such as its order item being shipped beyond its ordered quantity.

Filled only on the result of a create or update mutation; null when the shipment item is read. A warning never blocks the write.

ShipmentItem.orderItem ● OrderItem object​

Returned By​

shipmentItem query ● shipmentItemCreate mutation ● shipmentItemUpdate mutation

Member Of​

Shipment object ● ShipmentItemResponse object