githubEdit

Order event history

Introduction

The event history provides a chronological, immutable record of all operational events on an order or operative entity, supporting auditability, troubleshooting, and transparency. It shows what happened, when it happened, why it happened, and - if GDPR allows - who triggered the change. It covers the full lifecycle of orders and related entities such as pick jobs, pack jobs, parcels, handover jobs, routing plans, service jobs, and external actions. All events are exposed through the process history logs REST APIarrow-up-right.

A log entry always includes:

  • Domain: The entity type the event belongs to (e.g., ORDER, PARCEL, PICKJOB).

  • Event Type: Unique identifier for the event (e.g., ORDER_CREATED, PICKING_DONE)

  • Type: Category grouping for the event (e.g., ORDER_LIFECYCLE, FULFILLMENT)

  • Info: Human-readable event title displayed in the UI.

  • Time stamp: When the event occurred.

  • Event Cause: Detailed explanation of when and why this event occurs.

  • User: Information about the user or system that triggered the event. The user object is only included in the event history entry when the acting person may be recorded according to GDPR actorAnonymization; if user attribution is not permitted, the log entry is stored without user information.

  • Payload: Additional structured information depending on the event type.

Event Types

The following table describes all supported ProcessHistoryEventType values and their meaning.

ORDER_CREATED

The order was created in status OPEN.

LOCKED_ORDER_CREATED

The order was created in status LOCKED.

DELIVERY_PROMISE_CREATED

This indicates that an initial order delivery promise was generated.

ORDER_CREATED_FROM_PROMISE

The previously created delivery promise was confirmed and turned into a real order.

ORDER_CANCELLED

The order was cancelled by a user or system rule.

ORDER_FORCE_CANCELLED

The order was forcibly cancelled, bypassing standard validation.

ORDER_UNLOCKED

A previously locked order was unlocked.

ORDER_MANUAL_REROUTE

A user manually triggered a reroute.

UNROUTABLE_ITEMS_REROUTE

A reroute of the unroutable items was triggered.

ORDER_MANUAL_FACILITY_ASSIGNMENT

A user manually assigned a facility to the order.

ORDER_TIME_TRIGGERED_REROUTE

A scheduled rule triggered a reroute.

ORDER_HAS_UNROUTABLE_ITEMS

The system detected items that cannot be routed.

ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE

A reroute was triggered due to inactivity.

TASK_MANUAL_REROUTE

A user manually rerouted a picking task, not the complete order.

CONSUMER_ADDRESS_CHANGED

The consumer’s address was updated.

ORDER_ITEM_AMOUNT_CHANGED

The quantity of the original order line item changed.

ORDER_ITEM_DELETED

A line item was removed from the original order.

ORDER_ITEM_ADDED

A new item was added to the original order.

ORDER_PREFERRED_DATE_MODIFIED

The preferred handling or delivery date was updated.

OPERATIVE_TASK_CREATED

A pick job or handover job was created.

PICKING_IN_PROGRESS

Picking started.

PICKING_DONE

Picking was completed successfully.

PICKING_DONE_INCOMPLETE

Picking finished with missing items.

PICKING_ABORTED_NO_ITEMS_PICKED

Picking was aborted without picking any items.

PICKING_RESET

A picking process was reset.

PICKING_RESTART

A picking process was restarted.

PACKING_CREATED

A packing job was created.

PACKING_IN_PROGRESS

Packing started.

PACKING_DONE

Packing was completed.

PARCEL_CREATED

A parcel was created.

HANDOVER_CREATED

A handover job was created.

HANDOVER_DONE

Handover was completed successfully.

HANDOVER_DONE_WITH_REFUSED_ITEMS

Handover completed with refused items.

HANDOVER_CANCELED

A handover job was cancelled.

SERVICEJOB_CREATED

A service job was created.

SERVICEJOB_IN_PROGRESS

A service job started.

SERVICEJOB_DONE

A service job was completed.

SERVICEJOB_CANCELED

A service job was cancelled.

ACTION_TRIGGERED

An external action was triggered.

COMMENT_ADDED

A user added a comment to the entity.

Payload Overview

Depending on the event type, the payload provides additional structured information. Examples include:

  • Reroute payloads (manual, automatic, unroutable items) Contain reroute reasons, localized descriptions, and target facility information.

  • Order cancellation payload Includes cancellation reasons and localized texts.

  • Order modification payloads Cover address changes, preferred handling time updates, and line item modifications.

  • Operative entity payloads Provide facility context for pick, pack, and service jobs.

  • Parcel label creation failure payload Includes facility information and an error message.

  • Picking incomplete payload Lists short-picked items and reasons.

Payloads are always tailored to the event type and may include localized fields, facility references, article details, or operational metadata.

Last updated