Sales #shipments #shipping #delivery #tracking #packing #dispatch #labels #email Raw .md

Shipments & Delivery

Manage outbound shipments, packing slips, shipping labels, carrier tracking, and order dispatch.

Routes: /shipments /shipments/:id

Shipments & Delivery

The Shipments module tracks the physical packaging and dispatch of goods to customers. It links warehouse picking to carrier tracking numbers, generates shipping labels and delivery dockets, supports customer emailing, and automatically updates sales order fulfillment states.


Shipment Lifecycle & Rules

stateDiagram-v2
    [*] --> Draft : Create Shipment
    Draft --> Packing : Start Packing
    Packing --> Dispatched : Hand Over to Carrier
    Dispatched --> Delivered : Customer Receives
    Draft --> Cancelled : Cancel
    Packing --> Cancelled : Cancel

Key Rules

  1. Partial Shipments Supported: Multiple shipments can be created against a single sales order when fulfilling in batches.
  2. Auto-Transition to Shipped: When all line items on a sales order have been 100% dispatched across shipments, the sales order automatically updates from picking to shipped.
  3. Fast-Track Barcode Dispatch: For high-volume warehouse fulfillment, operators can bypass manual shipment entry by using the Scan-to-Dispatch station (/inventory/shipping/scan-to-dispatch) to automatically create and dispatch shipments upon scanning.
  4. Reverting Shipments: If a shipment is cancelled before delivery, the committed quantities are released back to the warehouse, and if the order is no longer 100% shipped, its status reverts to picking.

Document Generation & Customer Emailing

  • Print Shipping Label: Generates a standardized Typst carrier dispatch label formatted with customer address, barcode, package counts, and carrier routing info.
  • Print Shipping Docket: Generates a packing docket itemizing dispatched SKUs, quantities, and serials for inclusion inside the parcel.
  • Email Shipping Docket: Opens the document email dialog to send the dispatch notification and PDF docket directly to the customer’s delivery contact.

Step-by-Step Workflows

1. Creating and Dispatching a Shipment (Manual Workbench)

  1. Go to SalesShipments (/shipments).
  2. Click New Shipment and select the Sales Order.
  3. Verify the delivery address and packed line quantities.
  4. Select the Carrier and enter the Tracking Number.
  5. Click Print Shipping Label to affix to cartons.
  6. Click Print Shipping Docket or Email Docket to send confirmation to the client.
  7. Click Mark as Dispatched.

2. Fast-Track Barcode Dispatch

  • Use the Scan-to-Dispatch terminal (/inventory/shipping/scan-to-dispatch) to scan Zebra pick labels directly, create shipments automatically, and mark them Dispatched in real time.

Field Reference

FieldDescription
Shipment NumberUnique shipment tracking identifier.
Sales OrderThe parent sales order being fulfilled.
Tracking NumberWaybill / tracking number for online tracking.
StatusStage in dispatch workflow (Draft, Packing, Dispatched, Delivered).
Delivery AddressDestination physical address for delivery.
Shipping NotesSpecial instructions for the delivery driver.

Field Reference & Data Dictionary

Key database fields, input parameters, and definitions associated with this workflow screen:

Field / Parameter Display Name Description & Rules
shipment_number Shipment Number Unique shipment identifier (e.g. SHP-2026-00089).
sales_order_id Sales Order Originating sales order for the dispatched items.
tracking_number Tracking Number Consignment tracking code provided by the carrier.
status Shipment Status Current shipment stage (Draft, Packing, Dispatched, Delivered, Cancelled).