Skip to main content

OrderShipmentUpdateInput

Autogenerated input type of OrderShipmentUpdate

input OrderShipmentUpdateInput {
  allowExceedingFulfillment: Boolean
  bolNumber: String
  carrierServiceId: ID
  clientMutationId: String
  dimensionUnit: ProductUomEnum
  height: Decimal
  length: Decimal
  numberOfCartons: Int
  numberOfPackages: Int
  numberOfPallets: Int
  otherFees: Decimal
  packageType: PackageTypeEnum
  referenceNumber: String
  shipmentId: ID!
  shipmentItems: [OrderShipmentItemInput!]
  shippedDate: ISO8601DateTime
  shippingFees: Decimal
  trackingDetails: [ShippingTrackingNumberInput!]
  trackingNumber: String
  trackingUrl: Url
  weight: Decimal
  weightUnit: ProductUomEnum
  width: Decimal
}

Fields​

OrderShipmentUpdateInput.allowExceedingFulfillment ● Boolean scalar common​

When false, a change that raises any fulfillment item’s shipped quantity above its quantity on the fulfillment is refused with E_SHIPMENT_EXCEEDS_FULFILLMENT. Defaults to true, which records the quantities as reported.

OrderShipmentUpdateInput.bolNumber ● String scalar common​

The bill of lading number, up to 100 characters. On update, null clears it.

OrderShipmentUpdateInput.carrierServiceId ● ID scalar common​

The Endless carrier-service ID returned by the ecCarrierServices query. Sets the shipment’s carrier and service names. A carrier’s own service code is not accepted. On update, null clears the carrier and service.

OrderShipmentUpdateInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

OrderShipmentUpdateInput.dimensionUnit ● ProductUomEnum enum products​

The unit of length for length, width, and height, such as CENTIMETER. Defaults to INCH. A unit that is not a unit of length is rejected.

OrderShipmentUpdateInput.height ● Decimal scalar common​

The shipment-level height, in dimensionUnit. Stored in inches to two decimal places. Does not create dimensions for individual packages. On update, null clears it.

OrderShipmentUpdateInput.length ● Decimal scalar common​

The shipment-level length, in dimensionUnit. Stored in inches to two decimal places. Does not create dimensions for individual packages. On update, null clears it.

OrderShipmentUpdateInput.numberOfCartons ● Int scalar common​

The total number of cartons in the shipment. A summary count only; individual carton records are not created. On update, null clears it.

OrderShipmentUpdateInput.numberOfPackages ● Int scalar common​

The total number of packages in the shipment. A summary count only; individual package records are not created, and the count is not calculated from numberOfCartons or numberOfPallets. On update, null clears it.

OrderShipmentUpdateInput.numberOfPallets ● Int scalar common​

The total number of pallets in the shipment. A summary count only; individual pallet records are not created. On update, null clears it.

OrderShipmentUpdateInput.otherFees ● Decimal scalar common​

Other fees recorded on the shipment. Null clears the amount.

OrderShipmentUpdateInput.packageType ● PackageTypeEnum enum orders​

The packaging category for the shipment, such as BOX or ENVELOPE. Defaults to PACKAGE on create; on update, omitted or null keeps the current type. Does not create individual package or container records.

OrderShipmentUpdateInput.referenceNumber ● String scalar common​

A booking, appointment, or pickup request number, up to 100 characters. Send a freight PRO number as trackingNumber. On update, null clears it.

OrderShipmentUpdateInput.shipmentId ● ID! non-null scalar common​

The shipment to update.

OrderShipmentUpdateInput.shipmentItems ● [OrderShipmentItemInput!] list input common​

Every line in the shipment, each with a SKU and the quantity in this shipment only. Include each fulfillment item once. Endless matches SKUs within the fulfillment and links the lines to its items automatically; when several items share a SKU, send fulfillmentItemId with the SKU. On update, the list replaces the shipment’s lines and a line left out is removed.

OrderShipmentUpdateInput.shippedDate ● ISO8601DateTime scalar common​

The date and time the shipment shipped, in ISO 8601 format with a timezone, such as 2026-09-23T14:30:00Z. When reporting an earlier shipment, supply its original shipping time.

OrderShipmentUpdateInput.shippingFees ● Decimal scalar common​

Picking, packing, packaging, and courier fees. Null records an unknown cost.

OrderShipmentUpdateInput.trackingDetails ● [ShippingTrackingNumberInput!] list input common​

The complete tracking list. Do not combine with trackingNumber or trackingUrl. On create, the first entry becomes the primary tracking number. On update, the list replaces the current tracking; omitted or null leaves it unchanged, and an empty list clears it.

OrderShipmentUpdateInput.trackingNumber ● String scalar common​

The primary carrier-assigned tracking number, up to 100 characters: a parcel tracking number or a freight PRO number. On update, null removes the primary number and keeps the others.

OrderShipmentUpdateInput.trackingUrl ● Url scalar common​

The complete HTTP or HTTPS URL where the primary tracking number can be tracked. When it is omitted and the tracking number or carrier service changes, Endless builds it from the carrier service’s tracking link and the tracking number, or clears it when the carrier service has no tracking link. Otherwise omitting it keeps the current URL. On update, null clears it.

OrderShipmentUpdateInput.weight ● Decimal scalar common​

The total weight of the shipment, in weightUnit. Stored in pounds to two decimal places. On update, null clears it.

OrderShipmentUpdateInput.weightUnit ● ProductUomEnum enum products​

The unit of mass for weight, such as KILOGRAM. Defaults to POUND. A unit that is not a unit of mass is rejected.

OrderShipmentUpdateInput.width ● Decimal scalar common​

The shipment-level width, in dimensionUnit. Stored in inches to two decimal places. Does not create dimensions for individual packages. On update, null clears it.

Member Of​

orderShipmentUpdate mutation