Skip to main content

OrderShipmentCreateInput

Autogenerated input type of OrderShipmentCreate

input OrderShipmentCreateInput {
  bolNumber: String
  carrierServiceId: ID
  clientMutationId: String
  cost: Decimal
  externalId: String
  fulfillmentId: ID!
  height: Decimal
  length: Decimal
  metadata: JSON
  numberOfCartons: Int
  numberOfPackages: Int
  numberOfPallets: Int
  orderId: ID!
  packageType: PackageTypeEnum
  referenceNumber: String
  shipmentId: ID
  shipmentItems: [OrderShipmentItemInput!]!
  shippedDate: ISO8601DateTime!
  trackingNumber: String
  trackingUrl: Url
  weight: Decimal
  width: Decimal
}

Fields​

OrderShipmentCreateInput.bolNumber ● String scalar common​

Optional bill of lading number for this shipment, up to 100 characters.

OrderShipmentCreateInput.carrierServiceId ● ID scalar common​

Optional Endless carrier-service ID returned by the ecCarrierServices query. Identifies the service used for this shipment and sets its carrier and service names. A carrier’s own service code is not accepted here.

OrderShipmentCreateInput.clientMutationId ● String scalar common​

Optional caller-supplied identifier echoed in the response to match it to this request. Does not prevent duplicate execution.

OrderShipmentCreateInput.cost ● Decimal scalar common​

Optional total shipping cost for this shipment, excluding the cost of its items. Expressed in major units of the company’s currency, such as 12.50 for $12.50 USD.

OrderShipmentCreateInput.externalId ● String scalar common​

Optional ID assigned to this shipment by your system, such as WMS-SHIP-12345. Use a different ID for each shipment against the same fulfillment, including partial shipments, and keep it unchanged when retrying the same shipment. If an active shipped record with this ID already exists for the fulfillment, the mutation returns a “Shipment already exists” error. It does not update or return the existing shipment. Omit this field if your system does not assign shipment IDs.

OrderShipmentCreateInput.fulfillmentId ● ID! non-null scalar common​

The Endless ID of the fulfillment order whose items shipped. It must belong to the order specified by orderId.

OrderShipmentCreateInput.height ● Decimal scalar common​

Optional shipment-level height, stored to two decimal places without unit conversion. This mutation does not accept a dimension unit or create dimensions for individual packages.

OrderShipmentCreateInput.length ● Decimal scalar common​

Optional shipment-level length, stored to two decimal places without unit conversion. This mutation does not accept a dimension unit or create dimensions for individual packages.

OrderShipmentCreateInput.metadata ● JSON scalar common​

Optional JSON object containing additional information from your system, such as warehouse references or the original shipment payload. Stored on the shipment; it does not replace the shipmentItems, tracking, or other named inputs.

OrderShipmentCreateInput.numberOfCartons ● Int scalar common​

Optional total number of cartons in this shipment. A summary count only; individual carton records are not created.

OrderShipmentCreateInput.numberOfPackages ● Int scalar common​

Optional total number of packages in this shipment. A summary count only; individual package records are not created. This count is not calculated from numberOfCartons or numberOfPallets.

OrderShipmentCreateInput.numberOfPallets ● Int scalar common​

Optional total number of pallets in this shipment. A summary count only; individual pallet records are not created.

OrderShipmentCreateInput.orderId ● ID! non-null scalar common​

The Endless ID of the order containing the fulfillment being shipped.

OrderShipmentCreateInput.packageType ● PackageTypeEnum enum orders​

Optional packaging category for the shipment, such as BOX or ENVELOPE. Defaults to PACKAGE when omitted. Does not create individual package or container records.

OrderShipmentCreateInput.referenceNumber ● String scalar common​

Optional booking, appointment, or pickup request number for this shipment, up to 100 characters. Send a freight PRO number as trackingNumber.

OrderShipmentCreateInput.shipmentId ● ID scalar common​

Optional UUID v4 to use as the new Endless shipment ID. Generated when omitted. Keep it unchanged when retrying the same shipment. An ID that has already been used returns a “Shipment already exists” error; the existing shipment is not updated or returned. Use externalId for the shipment reference assigned by your system.

OrderShipmentCreateInput.shipmentItems ● [OrderShipmentItemInput!]! non-null input common​

At least one line containing a SKU and the quantity in this shipment. Include each SKU once. Endless matches SKUs within the referenced fulfillment and links the shipment lines to its items automatically. For partial shipments, include only the units shipped now.

OrderShipmentCreateInput.shippedDate ● ISO8601DateTime! non-null scalar common​

The actual date and time this shipment was 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.

OrderShipmentCreateInput.trackingNumber ● String scalar common​

Optional carrier-assigned tracking number for this shipment, up to 100 characters: a parcel tracking number or a freight PRO number.

OrderShipmentCreateInput.trackingUrl ● Url scalar common​

Optional complete HTTP or HTTPS URL where this shipment can be tracked. Include any tracking number or other parameters needed to open the shipment’s tracking page.

OrderShipmentCreateInput.weight ● Decimal scalar common​

Optional total weight of the shipment, stored to two decimal places without unit conversion. This mutation does not accept a weight unit.

OrderShipmentCreateInput.width ● Decimal scalar common​

Optional shipment-level width, stored to two decimal places without unit conversion. This mutation does not accept a dimension unit or create dimensions for individual packages.

Member Of​

orderShipmentCreate mutation