ShipmentState
A shipment tracking record
Unique identifier
Associated order ID
Associated carrier ID
Delivery-specific physical destination, independent of address ownership
Read-only destination and schedule diagnostics for current allocations; never gates granular ingestion
Shipping address ID
shipmentNumberStringShipment number
trackingNumberStringTracking number
trackingUrlStringTracking URL
Shipment status
totalWeightFloatTotal weight
Total number of packages
shippingCostFloatShipping cost
Currency code
Estimated delivery timestamp (ISO8601)
Shipped timestamp (ISO8601)
Delivered timestamp (ISO8601)
notesStringOptional notes
createdAtString!Creation timestamp (ISO8601)
updatedAtString!Last update timestamp (ISO8601)
Source order. Requires order:read permission.
Shipping carrier. Requires carrier:read permission.
Packages in this shipment. Requires shipment:read permission.
View exact SDL
"""A shipment tracking record"""
type ShipmentState {
"""Unique identifier"""
id: ShipmentID!
"""Associated order ID"""
orderId: OrderID
"""Associated carrier ID"""
carrierId: CarrierID
"""
Delivery-specific physical destination, independent of address ownership
"""
destinationSnapshot: DeliveryAddressSnapshot
"""
Read-only destination and schedule diagnostics for current allocations; never gates granular ingestion
"""
consolidationCompatibility: ConsolidationCompatibility!
"""Shipping address ID"""
shippingAddressId: AddressID
"""Shipment number"""
shipmentNumber: String
"""Tracking number"""
trackingNumber: String
"""Tracking URL"""
trackingUrl: String
"""Shipment status"""
status: ShipmentStatus!
"""Total weight"""
totalWeight: Float
"""Total number of packages"""
totalPackages: Int
"""Shipping cost"""
shippingCost: Float
"""Currency code"""
currency: CurrencyISO
"""Estimated delivery timestamp (ISO8601)"""
estimatedDeliveryAt: ISO8601
"""Shipped timestamp (ISO8601)"""
shippedAt: ISO8601
"""Delivered timestamp (ISO8601)"""
deliveredAt: ISO8601
"""Optional notes"""
notes: String
"""Creation timestamp (ISO8601)"""
createdAt: String!
"""Last update timestamp (ISO8601)"""
updatedAt: String!
"""Source order. Requires order:read permission."""
order: OrderState
"""Shipping carrier. Requires carrier:read permission."""
carrier: CarrierState
"""Packages in this shipment. Requires shipment:read permission."""
packages: [ShipmentPackageState!]!
}One stable address across all schema views. Follow a field’s type to explore connections between domains.