Skip to main content

Shipment

Shipment entity representing a package or delivery containing order items with tracking and fulfillment information

type Shipment {
  id: String!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  expectedDeliveryAt: DateTime
  status: ShipmentStatus
  orderId: Int!
  items: [ShipmentItem!]
  trackAndTraces: [TrackAndTrace!]
}

Fields​

Shipment.id ● String! non-null scalar​

Unique UUID identifier for the shipment.

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

Shipment.createdAt ● DateTime! non-null scalar​

Timestamp when the shipment was initially created in the system.

Used for tracking shipment processing timelines and audit trails.

Shipment.lastModifiedAt ● DateTime! non-null scalar​

Timestamp of the most recent update to the shipment record.

Reflects when any shipment information was last changed, including status updates, tracking information, or item modifications.

Shipment.expectedDeliveryAt ● DateTime scalar​

Estimated date and time when the shipment is expected to be delivered to the customer.

Based on carrier estimates and shipping method selected. Used for customer communication and delivery planning.

Shipment.status ● ShipmentStatus enum​

Current processing status of the shipment.

Indicates the shipment's position in the fulfillment workflow (e.g., 'pending', 'shipped', 'in_transit', 'delivered', 'cancelled').

Shipment.orderId ● Int! non-null scalar​

Reference to the parent order that this shipment fulfills.

Links the shipment to the original customer order for tracking and customer service purposes.

Shipment.items ● [ShipmentItem!] list object​

Collection of individual items included in this shipment.

Each item represents a portion of an order item being shipped, including quantities and product details.

Shipment.trackAndTraces ● [TrackAndTrace!] list object​

Collection of tracking events and status updates for this shipment.

Provides detailed tracking history including carrier updates, location changes, and delivery confirmations.

Returned By​

shipment query ● shipmentCreate mutation ● shipmentUpdate mutation

Member Of​

Order object ● ShipmentResponse object