Skip to content
Copy site link for AI

Warehouse Shipments Realtime-enabled — SmartConnect can trigger on changesRealtime-enabled

GETTable: Warehouse Shipment Header

eOne/core/v1.0/warehouseShipments

Warehouse shipments and their lines. Read the document to track picking and shipping, and post it when the goods leave.

You do not create a warehouse shipment by POSTing here. Its lines are pulled from released source documents, not authored. Create one with the createWarehouseShipment action on a sales order.

How a shipment is created

Release the sales order, then call the action. The order's location must have Require Shipment enabled. Otherwise there is nothing to hand to the warehouse and the call errors:

POST /salesOrders(<id>)/Microsoft.NAV.release
POST /salesOrders(<id>)/Microsoft.NAV.createWarehouseShipment

The response redirects to the newly created warehouseShipment, so you get its id and number back without a search. From there, GET the shipment and $expand=warehouseShipmentLines to follow picking and shipping.

A shipment as a vehicle load

For own-fleet dispatch a warehouse shipment doubles as one van's delivery load: createDeliveryLoad on salesOrders assembles a single shipment from several released orders, stamping the external planner's route id onto integrationId, the vehicle onto shippingAgentCode / shippingAgentServiceCode, and the route date onto shipmentDate. The planner then writes the ordered drops back as routeStops, readable inline here via $expand=routeStops, and shown to the warehouse on the Business Central shipment page as the loading sequence. The inbound mirror (a pickup load) is a warehouse receipt.

Consignment weight and volume

totalWeight and totalVolume roll the whole document up for you: they sum the shipment lines' weight and cubage, so a carrier-rating call can read one header instead of summing lines client-side.

Both are unitless numbers. Business Central stores no unit alongside them. The values are in whatever mass and length/volume units the company works in, exactly as the item cards were set up. Convert them to the unit the carrier expects in the map; do not assume kilograms or cubic metres.

The rollup is only as good as the item master. A line whose item carries no unit weight or unit volume contributes nothing to the total, so a shipment can legitimately report a total of zero.

Posting the shipment

The post bound action ships the whole document (basic warehousing. No separate pick step). It returns 204 rather than redirecting, because one shipment can post several source documents:

POST /warehouseShipments(<id>)/Microsoft.NAV.post
A fully shipped shipment is removed by Business Central after posting. Confirm the posted result through the sales shipment reports.

$expand=warehouseShipmentLines to follow the individual lines and trace each back to its source order. See Warehouse Shipment Lines.