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, delivered, in_receiving, closed, or canceled

Related Data

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 @deprecated
  brandId: ID @deprecated
  canBeSentToWms: Boolean!
  carrierName: String
  childShipments: [SupplyShipment!]!
  containerNumber: String
  containerSize: SupplyContainerSizeEnum
  costAllocation: POCostAllocationStatusEnum
  costsMethod: SupplyCostMethodEnum
  createdAt: ISO8601DateTime!
  currentStatus: SupplyShipmentStatus
  destinationBuilding: Warehouse
  destinationBuildingId: ID
  destinationName: String
  expectedArrivalDate: ISO8601DateTime
  expectedShipDate: ISO8601DateTime
  externalId: String
  financial: SupplyShipmentFinancial
  forwarderName: String
  id: ID!
  incoterms: SupplyIncotermsEnum
  items: [SupplyShipmentItem!]!
  notes: [Note!]!
  origin: String
  parentShipment: SupplyShipment
  parentShipmentId: ID
  paymentStatus: SupplyPaymentStatusEnum
  previousStatus: SupplyShipmentStatus
  purchaseOrders: [PurchaseOrder!]!
  refNumber: String
  shipmentNumber: String!
  shipmentType: SupplyShipmentTypeEnum!
  stats: SupplyShipmentStats!
  statusName: SupplyShipmentStatusEnum!
  statuses: [SupplyShipmentStatus!]!
  trackingNumber: String
  transportMode: SupplyTransportModeEnum
  updatedAt: ISO8601DateTime!
  vesselName: String
  wmsUrl: Url
}

Fields

SupplyShipment.actualArrivalDate ● ISO8601DateTime scalar common

Actual date/time of arrival at destination

SupplyShipment.actualShipDate ● ISO8601DateTime scalar common

Actual date/time when the shipment was dispatched

SupplyShipment.attachments ● [File!] list object common

SupplyShipment.bolNumber ● String scalar common

Bill of Lading number

SupplyShipment.brand ● Brand deprecated object common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

Brand this shipment belongs to

SupplyShipment.brandId ● ID deprecated scalar common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

ID of the brand this shipment belongs to

SupplyShipment.canBeSentToWms ● Boolean! non-null scalar common

Indicates whether the shipment can be sent to the WMS.

SupplyShipment.carrierName ● String scalar common

Name of the shipping carrier

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

Child shipments created from splitting this shipment

SupplyShipment.containerNumber ● String scalar common

Container number for containerized shipments

SupplyShipment.containerSize ● SupplyContainerSizeEnum enum common

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

SupplyShipment.costAllocation ● POCostAllocationStatusEnum enum purchase-orders

Cost allocation method or code

SupplyShipment.costsMethod ● SupplyCostMethodEnum enum common

Type of costs method

SupplyShipment.createdAt ● ISO8601DateTime! non-null scalar common

Timestamp when the shipment was created

SupplyShipment.currentStatus ● SupplyShipmentStatus object shipments

The most recent status record for this shipment

SupplyShipment.destinationBuilding ● Warehouse object warehouses

Destination building/warehouse where the shipment is being delivered

SupplyShipment.destinationBuildingId ● ID scalar common

ID of the destination building/warehouse

SupplyShipment.destinationName ● String scalar common

Name/description of the destination location

SupplyShipment.expectedArrivalDate ● ISO8601DateTime scalar common

Expected date of arrival at destination

SupplyShipment.expectedShipDate ● ISO8601DateTime scalar common

Expected date when the shipment will be dispatched

SupplyShipment.externalId ● String scalar common

The shipment ID in the external WMS system. If this value is present, it means the shipment was sent to the WMS.

SupplyShipment.financial ● SupplyShipmentFinancial object shipments

Financial details associated with this shipment

SupplyShipment.forwarderName ● String scalar common

Name of the freight forwarder

SupplyShipment.id ● ID! non-null scalar common

Unique identifier of the shipment

SupplyShipment.incoterms ● SupplyIncotermsEnum enum common

International Commercial Terms code

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

Items included in this shipment

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

Notes attached to this shipment

SupplyShipment.origin ● String scalar common

Origin location/address of the shipment

SupplyShipment.parentShipment ● SupplyShipment object shipments

Parent shipment if this is a split/child shipment

SupplyShipment.parentShipmentId ● ID scalar common

ID of the parent shipment if this is a child shipment

SupplyShipment.paymentStatus ● SupplyPaymentStatusEnum enum common

Payment status of the shipment

SupplyShipment.previousStatus ● SupplyShipmentStatus object shipments

The second most recent status record for this shipment

SupplyShipment.purchaseOrders ● [PurchaseOrder!]! non-null object purchase-orders

Purchase orders associated with this shipment, derived through item-level PO links

SupplyShipment.refNumber ● String scalar common

Reference number for tracking or customs

SupplyShipment.shipmentNumber ● String! non-null scalar common

Unique shipment number/reference

SupplyShipment.shipmentType ● SupplyShipmentTypeEnum! non-null enum shipments

Type of shipment (shipment or ASN)

SupplyShipment.stats ● SupplyShipmentStats! non-null object shipments

Statistical data related to this shipment

SupplyShipment.statusName ● SupplyShipmentStatusEnum! non-null enum shipments

Current status of the shipment

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

Status history ordered by most recent first

SupplyShipment.trackingNumber ● String scalar common

Tracking number for the shipment

SupplyShipment.transportMode ● SupplyTransportModeEnum enum common

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

SupplyShipment.updatedAt ● ISO8601DateTime! non-null scalar common

Timestamp when the shipment was last updated

SupplyShipment.vesselName ● String scalar common

Name of the vessel if shipped by sea

SupplyShipment.wmsUrl ● Url scalar common

Link to the WMS for the shipment. This field is only available if the shipment can be sent to the WMS and has been sent.

Returned By

supplyAssignShipmentCosts mutation ● supplyDistributeShipmentDimensions mutation ● supplyShipment query ● supplyUpdateShipmentCategoryCosts mutation

Member Of

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