← All types
In Input object

UpdateShipmentInput

Input for updating a shipment

Fields

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

Possible values (9)
DRAFT

Draft shipment

READY_FOR_PICKUP

Ready for carrier pickup

PICKED_UP

Picked up by carrier

IN_TRANSIT

In transit

OUT_FOR_DELIVERY

Out for delivery

DELIVERED

Delivered

FAILED_DELIVERY

Delivery failed

RETURNED

Returned

CANCELLED

Cancelled

Total weight

Total number of packages

Shipping cost

Currency code

Estimated delivery timestamp (ISO8601)

Shipped timestamp (ISO8601)

Delivered timestamp (ISO8601)

notes

StringOptional

Optional notes

Referenced by (1)
Exact type SDL
"""Input for updating a shipment"""
input UpdateShipmentInput {
  """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
}