Skip to main content

SupplyShipment

Represents a shipment in the supply chain system.

Shipments are physical movements of goods through the supply chain. They can be linked to purchase orders and track the movement of materials from origin to destination. Each shipment maintains its status, payment information, and relationship to other shipments (hierarchical parent-child structure).

Shipment Types​

  • **Shipment**: Direct shipment to a final destination (building/warehouse)
  • **ASN**: Advanced Shipment Notice, typically an intermediate shipment to a port or hub

Status Lifecycle​

Shipments progress through various statuses: pending, in_transit, at_destination, delivered, or canceled

Each shipment includes associated items, status history, brand information, purchase order reference, and destination facility information. Shipments can have parent-child relationships for consolidated/split shipment scenarios.

type SupplyShipment {
  actualArrivalDate: ISO8601DateTime
  actualShipDate: ISO8601DateTime
  attachments: [File!]
  bolNumber: String
  brand: Brand!
  brandId: ID!
  carrierName: String
  childShipments: [SupplyShipment!]!
  containerNumber: String
  containerSize: String
  costAllocation: String
  createdAt: ISO8601DateTime!
  currentStatus: SupplyShipmentStatus
  destinationBuilding: Warehouse
  destinationBuildingId: ID
  destinationName: String
  expectedArrivalDate: ISO8601Date
  expectedShipDate: ISO8601Date
  forwarderName: String
  id: ID!
  incoterms: String
  items: [SupplyShipmentItem!]!
  notes: [Note!]!
  origin: String
  parentShipment: SupplyShipment
  parentShipmentId: ID
  paymentStatus: SupplyPaymentStatusEnum
  previousStatus: SupplyShipmentStatus
  purchaseOrder: PurchaseOrder
  purchaseOrderId: ID
  refNumber: String
  shipmentNumber: String!
  shipmentType: SupplyShipmentTypeEnum!
  statusName: SupplyShipmentStatusEnum!
  statuses: [SupplyShipmentStatus!]!
  trackingNumber: String
  transportMode: String
  updatedAt: ISO8601DateTime!
  vesselName: String
}

Fields​

SupplyShipment.actualArrivalDate ● ISO8601DateTime scalar​

Actual date/time of arrival at destination

SupplyShipment.actualShipDate ● ISO8601DateTime scalar​

Actual date/time when the shipment was dispatched

SupplyShipment.attachments ● [File!] list object​

SupplyShipment.bolNumber ● String scalar​

Bill of Lading number

SupplyShipment.brand ● Brand! non-null object​

Brand this shipment belongs to

SupplyShipment.brandId ● ID! non-null scalar​

ID of the brand this shipment belongs to

SupplyShipment.carrierName ● String scalar​

Name of the shipping carrier

SupplyShipment.childShipments ● [SupplyShipment!]! non-null object​

Child shipments created from splitting this shipment

SupplyShipment.containerNumber ● String scalar​

Container number for containerized shipments

SupplyShipment.containerSize ● String scalar​

Container size (e.g., 20ft, 40ft)

SupplyShipment.costAllocation ● String scalar​

Cost allocation method or code

SupplyShipment.createdAt ● ISO8601DateTime! non-null scalar​

Timestamp when the shipment was created

SupplyShipment.currentStatus ● SupplyShipmentStatus object​

The most recent status record for this shipment

SupplyShipment.destinationBuilding ● Warehouse object​

Destination building/warehouse where the shipment is being delivered

SupplyShipment.destinationBuildingId ● ID scalar​

ID of the destination building/warehouse

SupplyShipment.destinationName ● String scalar​

Name/description of the destination location

SupplyShipment.expectedArrivalDate ● ISO8601Date scalar​

Expected date of arrival at destination

SupplyShipment.expectedShipDate ● ISO8601Date scalar​

Expected date when the shipment will be dispatched

SupplyShipment.forwarderName ● String scalar​

Name of the freight forwarder

SupplyShipment.id ● ID! non-null scalar​

Unique identifier of the shipment

SupplyShipment.incoterms ● String scalar​

International Commercial Terms code

SupplyShipment.items ● [SupplyShipmentItem!]! non-null object​

Items included in this shipment

SupplyShipment.notes ● [Note!]! non-null object​

Notes attached to this shipment

SupplyShipment.origin ● String scalar​

Origin location/address of the shipment

SupplyShipment.parentShipment ● SupplyShipment object​

Parent shipment if this is a split/child shipment

SupplyShipment.parentShipmentId ● ID scalar​

ID of the parent shipment if this is a child shipment

SupplyShipment.paymentStatus ● SupplyPaymentStatusEnum enum​

Payment status of the shipment

SupplyShipment.previousStatus ● SupplyShipmentStatus object​

The second most recent status record for this shipment

SupplyShipment.purchaseOrder ● PurchaseOrder object​

Purchase order associated with this shipment

SupplyShipment.purchaseOrderId ● ID scalar​

ID of the associated purchase order

SupplyShipment.refNumber ● String scalar​

Reference number for tracking or customs

SupplyShipment.shipmentNumber ● String! non-null scalar​

Unique shipment number/reference

SupplyShipment.shipmentType ● SupplyShipmentTypeEnum! non-null enum​

Type of shipment (shipment or ASN)

SupplyShipment.statusName ● SupplyShipmentStatusEnum! non-null enum​

Current status of the shipment

SupplyShipment.statuses ● [SupplyShipmentStatus!]! non-null object​

Status history ordered by most recent first

SupplyShipment.trackingNumber ● String scalar​

Tracking number for the shipment

SupplyShipment.transportMode ● String scalar​

Mode of transportation (e.g., air, sea, truck, rail)

SupplyShipment.updatedAt ● ISO8601DateTime! non-null scalar​

Timestamp when the shipment was last updated

SupplyShipment.vesselName ● String scalar​

Name of the vessel if shipped by sea

Returned By​

supplyAdvanceShipment mutation ● supplyRevertShipment mutation ● supplyShipment query

Member Of​

SupplyShipment object ● SupplyShipmentConnection object ● SupplyShipmentEdge object ● SupplyShipmentItem object ● SupplyShipmentStatus object