Skip to main content

Order Configurations

An Order Configuration is a template that defines how a specific order type functions in Mative Cloud Fleet Management. Every order must reference an Order Configuration, which governs its lifecycle, data fields, and proof-of-delivery requirements.

What an Order Configuration Contains

ComponentDescription
NameDisplay name (e.g., "Standard Delivery", "Cold Chain")
Namespace & KeyUnique identifier used by the API (e.g., system:order-config:transport)
DescriptionInternal notes on this configuration's purpose
StatusActive or inactive
Activity FlowThe ordered sequence of statuses the order moves through
Entity DefinitionsCustom fields for items (parcels) within the order payload
POD MethodHow proof of delivery is captured (signature, photo, QR, custom)
Custom FieldsAdditional order-level fields shown in the console and FM Mobile app
TagsLabels for filtering and organization

The Activity Flow

The activity flow defines the exact sequence of statuses a driver must complete in the FM Mobile app. The system includes four static statuses (cannot be removed):

  • created
  • dispatched
  • started
  • canceled

All intermediate steps between started and completion are configurable. A step with complete: true closes the order.

Example flow:

created → dispatched → started → enroute → arrived → completed

Cold chain example:

created → dispatched → started → picked_up → in_transit → delivered

The Built-in Core Configuration

Mative Cloud Fleet Management includes one default configuration:

FieldValue
NameTransport
Namespacesystem:order-config:transport
Default flowcreated → dispatched → started → enroute → completed

Managing Configurations

Navigate to Fleet Management → Operations → Order Configurations.

Available actions:

  • Create new configurations
  • Edit existing flows and entity fields
  • Duplicate a configuration as a starting point
  • Activate/Deactivate availability
  • Delete unused configurations

API Usage

When creating orders via the API, reference configurations by their public_id:

{
"order_config": "config_dnid32",
"payload": { ... }
}
note

The API uses public_id values exclusively — internal uuid columns remain database-private.