Order Creation

Functional description of the manual entry, management and search of transport orders in X4fleet.

The transport order (also: shipment) is the central entity in X4fleet. It describes what is to be picked up and delivered, when and where. This chapter describes the manual entry of a new order in the web interface and explains all relevant fields, functions and processes.


1. Creating a New Order

A new order is created via the Orders overview. The «New Order» button opens an entry form (dialog window / WinBox).

Mandatory Fields

The following fields must be filled in as a minimum so that an order can be saved and released:

FieldDesignation in the systemNote
Planned Tour DateShipment.DatePickupDate on which the transport is to take place
Pickup Location (From Point)Shipment.PickupMust be a valid, geocoded location
Delivery Location (To Point)Shipment.DropoffMust be a valid, geocoded location

Note: Depending on the tenant's system configuration, additional fields may be defined as mandatory, e.g. client, trip number or time window.

Optional Fields

All other fields are optional but provide the dispatcher with important planning information:

FieldDesignation in the systemPurpose
ClientShipment.ProviderContactNameCompany/person that commissioned the transport
CustomerShipment.ClientEnd customer (recipient), if different from the client
External Shipment ReferenceShipment.ExtRefIdReference from the customer system / ERP
Trip NumberShipment.TruckLoadNrInternal trip number
Shipment NoteShipment.NotesVisible to driver and dispatcher
Dispatch NotesShipment.NoteHiddenForDriverVisible only to dispatchers (not to drivers)
Planning AreaShipment.PlanningAreaAssignment to a planning area
Transport TypeShipment.ShipmentTypeType of transport (configurable per tenant)
Agreed IncomeShipment.AgreedIncomeOverrides the calculated subcontractor tariff
Full Truck LoadShipment.IsFullTruckTransportMarks a full transport (exclusive vehicle)
Must Be Driven TogetherShipment.MustBeDrivenTogetherShipments must be handled at the same tour stop
Custom FieldShipment.CustomFieldFreely configurable field (must be enabled in the backend)
Email AddressesShipment.DeliveryNoteMailsEmail addresses for the automatic delivery note dispatch
ChecklistsShipment.ChecklistsShipment-relevant checklists (predefined in the backend)
AttachmentsShipment.Attachment.TitleAttach documents via drag & drop
SubcontractorShipment.SubcontractorAssigns the order to a subcontractor (selection with autocomplete)

Note on the field Subcontractor: The field is displayed if the order is already assigned to a subcontractor, or if the module Master subcontractor is active for the group and Shipment sharing enabled is switched on (not for skip orders). See Settings › Subcontractors and Subcontractor Relationships. The subcontractor can only be changed as long as the order is not allocated to a tour. As soon as the order is planned, the field is greyed out and a change is no longer possible. The field is not displayed to the subcontractor's own users.


2. From/To Points (Pickup Location and Delivery Location)

What Is a «Location»?

A location (also: POI – Point of Interest) is a place in X4fleet with a stored address and GPS coordinates. It is the basis for tour planning and route calculation. Locations can be master data (permanently stored) or entered temporarily for this order only.

Pickup Location (From Point)

The pickup location defines where the goods are loaded. The following details can be entered:

FieldDescription
Name / Name2Designation of the location (e.g. company name, department)
OrganisationCompany at the pickup address
AddressStreet, postal code, town, country
Contact PhonePhone number of the contact person on site
EmailEmail of the contact person
Location Reference (RefId)Reference to the customer system (for master data linking)
Pickup NotesSpecific notes for the driver during pickup
Opening HoursStored opening hours of the location (from master data)
Loading Aids (From)Aids required for the pickup
Specialities (From)Special requirements at the pickup address

Delivery Location (To Point)

The delivery location defines where the goods are delivered. The fields are analogous to the pickup location. In addition:

FieldDescription
Delivery NotesSpecific notes for the driver during delivery
Loading Aids (To)Aids required for the delivery
Unloading QualificationsSpecific qualifications required during unloading

Searching or Creating a Location

When entering a location, the existing master data is searched first. If a location is found and selected, all stored data (address, coordinates, notes, opening hours etc.) is adopted automatically. If no matching location is found, a new address can be entered directly in the form. The system geocodes the address automatically.

Important: GPS coordinates must be present for tour planning and route calculation. Without valid coordinates, an order cannot be released.


3. Order Times and Time Windows

Planned Tour Date

The Planned Tour Date (Shipment.DatePickup) specifies on which day the transport is to take place. It is the primary planning date for the dispatcher.

Time Windows

In addition to the tour date, time windows can be stored for pickup and delivery. These specify to the driver and dispatcher the period within which the pickup or delivery must take place.

FieldDesignationDescription
Pickup FromWindowStartAEarliest pickup time
Pickup UntilWindowEndALatest pickup time
Delivery FromWindowStartBEarliest delivery time
Delivery UntilWindowEndBLatest delivery time

Possible Time Window Combinations

ScenarioFromUntilMeaning
From a point in timesetemptyGoods can be picked up from this point in time (no end)
Up to a point in timeemptysetGoods must be picked up by this point in time
Time windowsetsetGoods must be picked up within this interval
Fixed point in timeset= FromGoods must be picked up at exactly this point in time

Tip: Precise time windows considerably improve the quality of tour planning. The more accurate the time specifications, the more realistic the planned route.

Dwell Times

In addition to the time windows, the expected dwell times (loading and unloading times) can be entered:

FieldDesignationDescription
Approx. Loading Dwell Time (min)Shipment.ApproxLoadingTimeExpected loading duration in minutes
Approx. Unloading Dwell Time (min)Shipment.ApproxUnloadingTimeExpected unloading duration in minutes

These values feed into tour planning and influence the tour times.


4. Specialities, Vehicle Qualifications and Loading Aids

These three areas define special requirements for the transport. They must be preconfigured in the system backend.

Specialities

Specialities (Shipment.Special) describe special properties of the shipment or the transport process, e.g.:

  • Dangerous goods
  • Refrigeration requirement
  • Fragile goods
  • Express shipment

Specialities are displayed as checkboxes in the order and can be selected multiple times. They are purely informative or can be used as a filter criterion for dispatching. Specialities can be stored both at order level and specifically for the From point or To point.

Vehicle Qualifications

Vehicle qualifications (Shipment.Qualifications) define which vehicle properties are required for this transport, e.g.:

  • Tail lift
  • Refrigerated vehicle
  • Special body (e.g. silo, tanker)
  • Minimum loading capacity

The qualifications are matched against the vehicle master data during dispatching. Vehicles that do not meet the requirements are marked as unsuitable.

Loading Aids

Loading aids describe equipment required during loading or unloading, e.g.:

  • Pallet truck
  • Forklift
  • Hand truck
  • Special lashing straps

Loading aids can be entered at order level as well as separately for pickup (DropoffLoadingSupports) and delivery. The loading aid surcharge (Shipment.LoadingToolValue) can also be stored in the system.

Note: Which specialities, qualifications and loading aids are available is configurable per tenant.


5. Article Items (Shipment Items)

Overview

An order can contain one or more article items (products, services or load carriers). The items describe in detail what is being transported.

Fields of an Order Item

FieldDescription
ArticleReference to a master data article or free entry
QuantityNumber of units of the item
Unite.g. piece, pallet, kg, m³, litre, hours etc.
Total Gross Weight (kg)Total weight of the item
Total Gross Volume (m³)Total volume of the item
Number of PalletsPallet count (EUR pallet 80×120 cm)
Item Note (Pickup)Note for the driver during pickup
Item Note (Delivery)Note for the driver during delivery
BarcodeBarcode of the shipment item
Storage/Picking LocationSpecification of the storage location
ReferenceReference to an item in the customer system (e.g. sales order item)
PriceUnit price of the item (if pricing module is active)

Article Types

TypeDescription
ProductPhysical goods that are transported
ServiceService rendered (e.g. assembly, maintenance)
Load Carrier (Tool)Aid for the transport (e.g. pallet, mesh box)
Package (Container)Superordinate packaging unit that contains sub-articles

Dimension Fields at Order Level

The total quantities (weight, volume, pallets) are calculated automatically from the items and summarised at order level:

FieldDesignation
Gross Weight (kg)Shipment.BruttoWeight
Gross Volume (m³)Shipment.BruttoVolume
Gross Litres (l)Shipment.BruttoLiters
Gross Loading Metres (m)Shipment.BruttoLoadingMeters
Gross Area (m²)Shipment.BruttoSquareMetersPerUnit
Gross No. of PalletsShipment.BruttoPalletCount

Note: The gross fields at order level can also be overridden manually if the item details are not known.


6. Further Functions Within an Order

Create Next Order (Batch Entry)

With the «Create Next Order» function (Shipment.BatchCreation), a new order can be opened immediately after saving an order. This facilitates the quick entry of several orders in succession.

Copy Order

Existing orders can be duplicated. All fields of the original are adopted and can be adjusted. This function is useful when similar orders have to be entered regularly.

Load Template

Via «Select Template» (Action.OrderTemplate.Choose), an order can be prefilled based on a saved order template. Templates contain predefined fields and items.

Release Order

A saved order is initially in the status «In Progress». Upon release it changes to the status «Released» and becomes available to the dispatcher for tour planning. Before release, the system checks:

  • Are the pickup location and delivery location present with valid coordinates?
  • Is a tour date set?
  • Are all tenant-specific mandatory fields filled in?

Delivery Note

For a completed order, a delivery note (Shipment.DropoffDeliveryNotes) can be generated and sent by email. The recipient email addresses can be stored directly in the order under Shipment.DeliveryNoteMails.

Advising

Advising makes it possible to inform the customer (recipient) about the planned arrival time. The time of the advising is recorded in the system (PickupAdvisingSetTime, DropoffAdvisingSetTime).

Shipment Split

Orders can be split:

  • Quantity split: The shipment quantity is split across several partial shipments.
  • Route split: The shipment is split across different routes/stops.

Split shipments retain a parent-child relationship and are recognisable in the system as belonging together.


7. Order Templates and Recurring Orders

Order Template

An order template is a saved order that serves as the basis for new orders. Templates are suitable for transport orders that are entered regularly with similar data.

Create Template

In the order dialog there is the option to save the current order as a template:

  • Template name (mandatory field)
  • Notes on the template
  • Private (OrderTemplate.IsPrivate): Template is visible only to the creator
  • Template for recurring orders (OrderTemplate.IsRecurringOrderTemplate): Marks the template as a basis for recurring orders

Templates can be managed under Settings > Order Templates.


Recurring Order

A recurring order is a configuration that automatically or manually generates recurring transport orders from an order template. Recurring orders are ideal for daily, weekly or interval-based routes.

Recurring orders are managed under Settings > Recurring Orders.

Fields of the Recurring Order

FieldDescription
Recurring Order NameDesignation of the recurring order
Order TemplateLinked template (must be marked as «Template for recurring orders»)
Valid From / Valid UntilPeriod during which the recurring order is active
ActiveActivates or deactivates the recurring order
Generate ForWeekdays on which orders are generated (Mon–Sun)
Repeat Every X WeeksRepetition interval in weeks (e.g. only every 2nd week)
Automatic GenerationIf active, orders are generated automatically
Days Before Automatic GenerationHow many days in advance the order is to be created
Travel on Public HolidaysIf active, orders are also generated on public holidays
First ExecutionDate of the first execution
Time ExceptionsDates on which no orders should be generated

Generate Orders

Recurring orders can be:

  • Automatically generated (the system creates the orders in advance, configurable via «Days before automatic generation»).
  • Manually generated via «Generate Selected Recurring Order» or «Generate Recurring Orders».

Note: The generated orders are created in the status «In Progress» or directly «Released», depending on the system configuration.


8. Order Status

A transport order passes through various statuses during its lifecycle:

Shipment Status (Dispatch Status)

StatusMeaning
In ProgressOrder has been entered but not yet released. Can be fully edited.
ReleasedOrder has been released and is available to the dispatcher. Not yet assigned to a tour.
PlannedOrder has been assigned to a tour. Editing restrictions possible.
Pickup CompletedDriver has confirmed the pickup in the system.
Delivery CompletedDriver has confirmed the delivery in the system.
CompletedTransport order fully completed.
Completed with ReservationCompleted but with notes/deviations.
ReopenedA completed order has been reopened (e.g. for corrections).
Quantity SplitOrder has been split by quantity.
Route SplitOrder has been split by route.

Billing Status (Fiscal Status)

When the invoicing module is active, each order additionally has a billing status:

StatusMeaning
In ProgressNot yet billable
QuoteOrder is a quote
ConfirmedOrder confirmed
For BillingReady for invoicing
Billing in ProgressInvoicing in progress
BilledOrder has been invoiced
CancelledOrder has been cancelled

Editing Rules by Status

Depending on the configuration, the system prevents changes or deletions once an order has reached a certain status:

LimitPossible configuration
After Tour AssignmentOrder can no longer be changed or deleted
After Tour ReleaseChanges to key fields trigger warnings or locks
After Tour StartDeletion locked
After Loading StartComplete locking of all changes

Orders Overview

The Orders overview shows all orders in tabular form. The displayed list can be filtered and sorted by various criteria.

Filter Options

The following fields are typically available as search filters:

FilterDescription
Date From / UntilSearch by tour date within a specific period
StatusFilter by shipment status (e.g. only «Released»)
ClientSearch for a specific client
CustomerSearch for a specific end customer
From PointSearch by pickup location
To PointSearch by delivery location
External Shipment ReferenceSearch for an external reference (e.g. from the ERP)
Trip NumberSearch for an internal trip number
Shipment IDDirect search by the unique system ID
Created FromFilter by entry source (web, API, import, recurring order etc.)
Planning AreaFilter by assigned planning area
Transport TypeFilter by transport type
GroupFilter by subgroup (for tenant-specific groups)

Search Results

The search results show the configured columns of the Orders overview. These can be adjusted per user or globally. Clicking on a shipment opens the detail dialog.

Export Function

The filtered orders can be exported as an Excel file in order to process them further outside X4fleet.


10. Summary: Process of a Typical Order Entry

1. Open new order
   └─ Click «New Order»

2. Enter basic data
   ├─ Set planned tour date
   ├─ Select client (optional, but recommended)
   └─ Enter external reference (optional)

3. Enter From point (pickup location)
   ├─ Search and select an existing location, or
   ├─ Enter a new address (geocoded automatically)
   ├─ Set time window (from / until)
   └─ Enter pickup notes (optional)

4. Enter To point (delivery location)
   ├─ Search and select an existing location, or
   ├─ Enter a new address
   ├─ Set time window (from / until)
   └─ Enter delivery notes (optional)

5. Enter article items
   ├─ Select article from master data or enter a new one
   ├─ Set quantity and unit
   └─ Enter weight / volume / pallets (optional, if known)

6. Set specialities / qualifications / loading aids (optional)

7. Save
   └─ Order is saved in the status «In Progress»

8. Release
   └─ Order changes to status «Released»
      → Available to the dispatcher for tour planning