UpdateShipmentInput

Mutator to create a new shipment or update an existing one.

input UpdateShipmentInput {
  businessSlug: String!
  facilitySlug: String!
  shipmentNumber: String
  expectedArrivalAt: String
  direction: ShippingDirection
  carrier: String
  carrierService: String
  trailerNumber: String
  status: ShipmentUpdateStatus
  statusOccurredAt: String
  dockSlug: String
  driverName: String
  driverLicenseNumber: String
  driverLicensePlate: String
  driverEmailAddress: String
  equipmentType: EquipmentType
  serviceType: ServiceType
  shipmentType: ShipmentType
  sealNumber: String
  additionalFields: [ShipmentAdditionalField!]
}

Fields

UpdateShipmentInput.businessSlug ● String! non-null scalar

The short name referencing a business, e.g. "kargo".

UpdateShipmentInput.facilitySlug ● String! non-null scalar

The short name referencing a facility, e.g. "san-francisco".

UpdateShipmentInput.shipmentNumber ● String scalar

Unique facility-provided identification number for the shipment.

UpdateShipmentInput.expectedArrivalAt ● String scalar

Facility-provided appointment slot. For appointment slots spanning multiple hours, the starting timestamp.

UpdateShipmentInput.direction ● ShippingDirection enum

Direction of the Shipment associated with this Appointment.

UpdateShipmentInput.carrier ● String scalar

Carrier associated with the Shipment.

UpdateShipmentInput.carrierService ● String scalar

Carrier service associated with the Shipment, e.g. FTL / LTL / FCL / LCL.

UpdateShipmentInput.trailerNumber ● String scalar

Trailer number associated with the Shipment associated with this Appointment.

UpdateShipmentInput.status ● ShipmentUpdateStatus enum

Indicates what kind of event occurred.

UpdateShipmentInput.statusOccurredAt ● String scalar

When the event occurred, in ISO 8601 format.

UpdateShipmentInput.dockSlug ● String scalar

The short name referencing a dock, e.g. "D11".

UpdateShipmentInput.driverName ● String scalar

Name of driver for shipment

UpdateShipmentInput.driverLicenseNumber ● String scalar

License number of driver for shipment

UpdateShipmentInput.driverLicensePlate ● String scalar

License plate number of vehicle driven by driver for shipment

UpdateShipmentInput.driverEmailAddress ● String scalar

Email of driver for shipment

UpdateShipmentInput.equipmentType ● EquipmentType enum

Type of equipment used for shipment

UpdateShipmentInput.serviceType ● ServiceType enum

Type of service used for shipment

UpdateShipmentInput.shipmentType ● ShipmentType enum

Type of order associated with the shipment, e.g. GATEWAY_LOOP.

UpdateShipmentInput.sealNumber ● String scalar

Identification number for a container seal

UpdateShipmentInput.additionalFields ● [ShipmentAdditionalField!] list input

Member Of

CreateShipmentAndOrderInput input ● updateShipment mutation