Skip to main content

CreateSupplyShipmentInput

Autogenerated input type of CreateSupplyShipment

input CreateSupplyShipmentInput {
  bolNumber: String
  brandId: ID!
  carrierName: String
  clientMutationId: String
  containerNumber: String
  containerSize: String
  costAllocation: String
  costsMethod: SupplyCostMethodEnum
  createFromPurchaseOrder: Boolean
  destinationBuildingId: ID
  destinationName: String
  expectedArrivalDate: ISO8601DateTime
  expectedShipDate: ISO8601DateTime
  forwarderName: String
  incoterms: String
  origin: String
  parentShipmentId: ID
  paymentStatus: SupplyPaymentStatusEnum
  purchaseOrderId: ID
  refNumber: String
  reportedTotalCartons: Int
  reportedTotalPallets: Int
  reportedTotalVolume: Decimal
  reportedTotalWeight: Decimal
  shipmentItems: [SupplyShipmentItemInput!]
  shipmentNumber: String
  shipmentType: SupplyShipmentTypeEnum!
  trackingNumber: String
  transportMode: SupplyTransportModeEnum
  vesselName: String
}

Fields

`CreateSupplyShipmentInput.bolNumber` ● `String` scalar

`CreateSupplyShipmentInput.brandId` ● `ID!` non-null scalar

`CreateSupplyShipmentInput.carrierName` ● `String` scalar

`CreateSupplyShipmentInput.clientMutationId` ● `String` scalar

A unique identifier for the client performing the mutation.

`CreateSupplyShipmentInput.containerNumber` ● `String` scalar

`CreateSupplyShipmentInput.containerSize` ● `String` scalar

`CreateSupplyShipmentInput.costAllocation` ● `String` scalar

`CreateSupplyShipmentInput.costsMethod` ● `SupplyCostMethodEnum` enum

Defines the method to be used to calculate the shipment financials.

`CreateSupplyShipmentInput.createFromPurchaseOrder` ● `Boolean` scalar

If true and purchase_order_id is provided, pre-fill shipment details from the associated purchase order.

`CreateSupplyShipmentInput.destinationBuildingId` ● `ID` scalar

The building ID where the shipment is expected to arrive.

`CreateSupplyShipmentInput.destinationName` ● `String` scalar

Name of the intermediate destination (e.g., port name).

`CreateSupplyShipmentInput.expectedArrivalDate` ● `ISO8601DateTime` scalar

`CreateSupplyShipmentInput.expectedShipDate` ● `ISO8601DateTime` scalar

`CreateSupplyShipmentInput.forwarderName` ● `String` scalar

`CreateSupplyShipmentInput.incoterms` ● `String` scalar

`CreateSupplyShipmentInput.origin` ● `String` scalar

`CreateSupplyShipmentInput.parentShipmentId` ● `ID` scalar

The ID of the parent shipment, if this shipment is part of a larger shipment or if it is a child shipment associated with a parent shipment.

`CreateSupplyShipmentInput.paymentStatus` ● `SupplyPaymentStatusEnum` enum

`CreateSupplyShipmentInput.purchaseOrderId` ● `ID` scalar

If provided, links this shipment to a specific purchase order.

`CreateSupplyShipmentInput.refNumber` ● `String` scalar

`CreateSupplyShipmentInput.reportedTotalCartons` ● `Int` scalar

The total number of cartons in the shipment as reported by the supplier or carrier.

`CreateSupplyShipmentInput.reportedTotalPallets` ● `Int` scalar

The total number of pallets in the shipment as reported by the supplier or carrier.

`CreateSupplyShipmentInput.reportedTotalVolume` ● `Decimal` scalar

The total volume of the shipment as reported by the supplier or carrier.

`CreateSupplyShipmentInput.reportedTotalWeight` ● `Decimal` scalar

The total weight of the shipment as reported by the supplier or carrier.

`CreateSupplyShipmentInput.shipmentItems` ● `[SupplyShipmentItemInput!]` list input

`CreateSupplyShipmentInput.shipmentNumber` ● `String` scalar

The shipment number. If not provided, it will be auto-generated.

`CreateSupplyShipmentInput.shipmentType` ● `SupplyShipmentTypeEnum!` non-null enum

`CreateSupplyShipmentInput.trackingNumber` ● `String` scalar

`CreateSupplyShipmentInput.transportMode` ● `SupplyTransportModeEnum` enum

`CreateSupplyShipmentInput.vesselName` ● `String` scalar

Member Of

supplyCreateShipment mutation

Fields
Member Of