Shipment

A Shipment object represents a single combination of <trailer, Order>. A trailer split into multiple Orders would map to multiple Shipment. Similarily an Order split across multiple trailers would map to multiple Shipments.

type Shipment {
  id: Int!
  facility: Facility!
  dockId: Int
  dock: Dock
  cargo: [ShippingUnit!]!
  item(
    partID: String!
  ): ShippingItem
  shippingDirection: ShippingDirection
  arrivedAt: String
  loadingStartAt: String
  loadingEndAt: String
  departedAt: String
  purchaseOrder: String
  carrier: String
  carrierService: String
  statusEvents: [ShipmentStatusEvent!]!
  status: ShipmentStatus
  orders: [Order!]!
  customerShipmentIdentifier: String
  expectedArrivalAt: String
  documents: [ShipmentDocument!]!
}

Fields

Shipment.id ● Int! non-null scalar

Internal Kargo-ID for Shipment object.

Shipment.facility ● Facility! non-null object

Facility object that this Shipment is associated with.

Shipment.dockId ● Int scalar

Kargo-ID for the Dock that this Shipment is associated with.

Shipment.dock ● Dock object

Dock object that this Shipment is associated with.

Shipment.cargo ● [ShippingUnit!]! non-null object

ShippingUnit containing the real and expected grouping of ShippingItems on this Shipment.

Shipment.item ● ShippingItem object

Retrieve a ShippingItem from this Shipment by partID.

Shipment.item.partID ● String! non-null scalar

Shipment.shippingDirection ● ShippingDirection enum

The ShippingDirection automatically assigned to this shipment.

Shipment.arrivedAt ● String scalar

The UTC timestamp that this Shipment was first logged as ARRIVED by Kargo.

Shipment.loadingStartAt ● String scalar

The UTC timestamp for the first ShippingItem loggedo on this Shipment.

Shipment.loadingEndAt ● String scalar

The UTC timestamp for the last ShippingItem loggedo on this Shipment.

Shipment.departedAt ● String scalar

The UTC timestamp that this Shipment was first logged as CLEARED by Kargo.

Shipment.purchaseOrder ● String scalar

PO# associated with this Shipment.

Shipment.carrier ● String scalar

BOL-listed carrier associated with this Shipment.

Shipment.carrierService ● String scalar

Carrier service for this Shipment.

Shipment.statusEvents ● [ShipmentStatusEvent!]! non-null object

History of statuses for this Shipment.

Shipment.status ● ShipmentStatus enum

Current status for this Shipment.

Shipment.orders ● [Order!]! non-null object

List of Order objects associated with this Shipment.

Shipment.customerShipmentIdentifier ● String scalar

Customer-provided id for this Shipment.

Shipment.expectedArrivalAt ● String scalar

When the scheduled shipment is expected to arrive at the facility.

Shipment.documents ● [ShipmentDocument!]! non-null object

Documents uploaded for this shipment.

Returned By

shipment query

Member Of

CreateShipmentAndOrderResult object ● Dock object ● Facility object