← API reference
CANONICAL TYPE REFERENCE

CreateShipmentInput

Input for creating a shipment

Associated order ID

Associated carrier ID

Physical destination snapshot; omit to retain on updates, use an empty snapshot to record unknown

Shipping address ID

Shipment number

Tracking number

Tracking URL

Shipment status

Total weight

Total number of packages

Shipping cost

Currency code

Estimated delivery timestamp (ISO8601)

Shipped timestamp (ISO8601)

Delivered timestamp (ISO8601)

notesString

Optional notes

View exact SDL
"""Input for creating a shipment"""
input CreateShipmentInput {
  """Associated order ID"""
  orderId: OrderID
  """Associated carrier ID"""
  carrierId: CarrierID
  """
  Physical destination snapshot; omit to retain on updates, use an empty snapshot to record unknown
  """
  destinationSnapshot: DeliveryAddressSnapshotInput
  """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
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.