Skip to main content

supplyDistributeShipmentDimensions

Distributes a shipment's total weight or volume to individual line items using proportional allocation based on product dimensions.

Authentication​

Requires authentication and the supply:update_shipment_financials permission.

Behavior​

  • Accepts a single shipment and a distribution method.
  • Resolves per-unit dimensions via cascade: ShipmentItem, PO Item, then Product.
  • Calculates proportional values and persists them on each line item.
  • Returns the full shipment for Apollo cache update.

Valid Methods​

  • **WEIGHT**: distribute reported_total_weight proportionally by each item's product weight.
  • **VOLUME**: distribute reported_total_volume proportionally by each item's product volume (length x width x height).

Possible Errors​

  • Shipment not found - The specified shipment does not exist.
  • No items eligible for distribution - No line items have the required measurement data at any cascade level.
supplyDistributeShipmentDimensions(
  input: DistributeShipmentDimensionsInput!
): SupplyShipment!

Arguments​

supplyDistributeShipmentDimensions.input ● DistributeShipmentDimensionsInput! non-null input common​

Parameters for DistributeShipmentDimensions

Type​

SupplyShipment object shipments​

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

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.