Available Events

Models to the Payloads can be found in our OpenAPI Specification: https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/api.swagger.yaml in the corresponding path (see "Type of Payload")

Overview of available events

Event	Type of Payload	Description	API Lifecycle
UPCOMING_TIME_TRIGGERED_REROUTE	UpcomingTimeTriggeredReroute (/components/schema/UpcomingTimeTriggeredRerouteWebHookEvent)	A time triggered reroute is imminent.	GA (general available)
EXTERNAL_ACTION_EXECUTED	ExternalActionExecuted (/components/schema/ExternalActionExecutedWebHookEvent)	An external action was executed.	GA (general available)
ORDER_CREATED	Order (/components/schema/OrderCreatedWebHookEvent)	An order has been created.	GA (general available)
ORDER_CANCELLED	Order (/components/schema/OrderCancelledWebHookEvent)	An order has been cancelled.	GA (general available)
ORDER_UNLOCKED	Order (/components/schema/OrderUnlockedWebHookEvent)	An order has been unlocked.	GA (general available)
ORDER_FORCE_CANCELLED	Order (/components/schema/OrderForceCancelledWebHookEven)	An order has been force cancelled	GA (general available)
INVENTORY_FACILITY_STOCK_CHANGED	InventoryFacilityStock (/components/schema/InventoryFacilityStockChangedWebHookEvent)	The aggregated stock availability of one product (identified by itstenantArticleId) in a specific facility (identified by thefacilityRef) has changed. This can, for example, mean changes in the total stock,the reserved amount or some other factors.	GA (general available)
INBOUND_DELIVERY_RECEIVED	InboundDeliveryReceived (/components/schema/InboundDeliveryReceivedWebHookEvent)	A new receipt was finished, indicating that new stock was accepted in the facility.	GA (general available)
INBOUND_DELIVERY_FINISHED	InboundDeliveryFinished (/components/schema/InboundDeliveryFinishedWebHookEvent)	A new receipt was finished and the corresponding inbound process was completed, meaning the amount of received items for each requested line item is reached or exceeded.	GA (general available)
INBOUND_DELIVERY_ON_HOLD	InboundDeliveryOnHold (/components/schema/InboundDeliveryOnHoldWebHookEvent)	An inbound process was placed on hold by setting the onHold flag to true. This means the process should be paused for now.	GA (general available)
INBOUND_DELIVERY_RELEASED	InboundDeliveryFinished (/components/schema/InboundDeliveryReleasedWebHookEvent)	An inbound process was released from onHold status by setting the onHold flag to false. This means the process can be continued.	GA (general available)
ROUTING_PLAN_SPLITTED	RoutingPlan(/components/schema/RoutingPlanSplittedWebHookEvent)	A routing plan has been split into multiple parts.	GA (general available)
ROUTING_PLAN_WAITING	RoutingPlan (/components/schema/RoutingPlanWaitingWebHookEvent)	A routing plan is waiting for external events in order to get routed.	GA (general available)
ROUTING_PLAN_FALLBACK	RoutingPlan (/components/schema/RoutingPlanFallbackRoutingWebHookEvent)	A routing plan has been routed to its fallback facility.	GA (general available)
ROUTING_PLAN_ROUTED	RoutingPlan (/components/schema/RoutingPlanRoutedWebHookEvent)	A routing plan has been routed successfully.	GA (general available)
ROUTING_PLAN_CANCELLED	RoutingPlan (/components/schema/WebHookEvent with /components/schema/RoutingPlan as Payload)	A routing plan has been cancelled.	GA (general available)
ROUTING_PLAN_REROUTEPLAN_CREATED	RoutingPlan (/components/schema/RoutingPlanRerouteCreatedWebHookEvent)	A reroute plan has been created for a routing plan	GA (general available)
ROUTING_PLAN_NOT_ROUTABLE	RoutingPlan (/components/schema/RoutingPlanNotRoutableWebHookEvent)	An order could not be routed. The routing plan that was used is attached.	GA (general available)
FACILITY_CREATED	Facility (/components/schema/FacilityCreatedWebHookEvent)	A facility has been created.	GA (general available)
FACILITY_UPDATED	Facility (/components/schema/FacilityUpdatedWebHookEvent)	A facility has been updated.	GA (general available)
FACILITY_DELETED	Facility (/components/schema/FacilityDeletedWebHookEvent)	A facility has been deleted.	GA (general available)
PICK_JOB_CREATED	Pickjob (/components/schema/PickJobCreatedWebHookEvent)	A pick job has been created.	GA (general available)
PICK_JOB_PICKING_COMMENCED	Pickjob (/components/schema/PickjobPickingCommencedWebHookEvent)	A pick job is being picked.	GA (general available)
PICK_JOB_PICKING_PAUSED	Pickjob (/components/schema/PickjobPickingPausedWebHookEvent)	A pick job has been paused.	GA (general available)
PICK_JOB_PICKING_FINISHED	Pickjob (/components/schema/PickjobPickingFinishedWebHookEvent)	A pick job was finished.	GA (general available)
PICK_JOB_PICK_LINE_PICKED	Pickjob (/components/schema/PickJobPickLinePickedWebHookEvent)	A pick line of a pick job has been picked.	GA (general available)
PICK_JOB_REROUTED	Pickjob (/components/schema/WebHookEvent with /components/schema/PickJobas Payload)	A pick job has been rerouted to another facility.	GA (general available)
PICK_JOB_RESET	Pickjob (/components/schema/WebHookEvent with /components/schema/PickJobas Payload)	A pick job has been reset.	GA (general available)
PICK_JOB_ABORTED	Pickjob (/components/schema/PickjobPickingAbortedWebHookEvent)	A pick job has been aborted because nothing was picked.	GA (general available)
PICK_JOB_CANCELED	Pickjob (/components/schema/PickjobPickingCanceledWebHookEvent)	A pick job has either been directly canceled or its order has been canceled.	GA (general available)
PACK_JOB_CREATED	Packjob (/components/schema/PackJobCreatedWebHookEvent)	A new pack job has been created.	GA (general available)
PACK_JOB_UPDATED	Packjob (/components/schema/PackJobUpdatedWebHookEvent)	A pack job was updated.	GA (general available)
PACK_JOB_CANCELED	Packjob (/components/schema/PackjobPackingCanceledWebHookEvent)	A packJob has either been directly canceled or its pickJob has been canceled.	GA (general available)
PACK_JOB_CLOSED	Packjob (/components/schema/PackjobPackingClosedWebHookEvent)	Packing of a PackJob has finished and it was set to CLOSED	GA (general available)
HANDOVERJOB_CREATED	Handoverjob (/components/schema/HandoverJobCreatedWebHookEvent)	A handover job has been created.	GA (general available)
HANDOVERJOB_HANDED_OVER	Handoverjob (/components/schema/HandoverJobHandedOverWebHookEvent)	A handover job has been handed over.	GA (general available)
HANDOVERJOB_REVERTED	Handoverjob (/components/schema/HandoverJobRevertedWebHookEvent)	This event is published, when a handover job is set back to OPEN manually.	GA (general available)
HANDOVERJOB_CANCELED	Handoverjob (/components/schema/HandoverJobCanceledWebHookEvent)	A handover job has been canceled.	GA (general available)
PARCEL_CARRIER_REQUESTED	Parcel (/components/schema/ParcelCarrierRequestedWebHookEvent)	FFT platform started processing of the parcel.	GA (general available)
PARCEL_CARRIER_FAILED	Parcel (/components/schema/ParcelCarrierFailedWebHookEvent)	The label could not be created.	GA (general available)
PARCEL_CARRIER_ACKNOWLEDGED	Parcel (/components/schema/ParcelCarrierAcknowledgedWebHookEvent)	The label was successfully created and the label can now be downloaded.	GA (general available)
ITEM_RETURN_JOB_CREATED	ItemReturnJob (/components/schema/WebHookEvent with /components/schema/ItemReturnJob as Payload)	ItemReturnJob has been created.	GA (general available)
ITEM_RETURN_JOB_UPDATED	ItemReturnJob (/components/schema/WebHookEvent with /components/schema/ItemReturnJob as Payload)	ItemReturnJob has been updated.	GA (general available)
RETURN_CANCELED	Return (/components/schema/ReturnJobCanceledWebHookEvent)	Return has been canceled.	GA (general available)
RETURN_CLAIMED	Return (/components/schema/ReturnJobClaimedWebHookEvent)	Return has been claimed.	GA (general available)
RETURN_CLOSED	Return (/components/schema/ReturnJobClosedWebHookEvent)	Return has been closed.	GA (general available)
RETURN_CREATED	Return (/components/schema/ReturnJobCreatedWebHookEvent)	Return has been created.	GA (general available)
RETURN_UPDATED	Return (/components/schema/WebHookEvent with /components/schema/ReturnJob as Payload)	Return has been updated.	GA (general available)
SHIPMENT_CREATED	Shipment (/components/schema/ShipmentCreatedWebHookEvent)	Shipment has been created.	GA (general available)
SHIPMENT_UPDATED	Shipment (/components/schema/ShipmentUpdatedWebHookEvent)	Shipment has been updated.	GA (general available)
USER_CREATED	User (/components/schema/UserCreatedWebHookEvent)	A user has been created.	GA (general available)
USER_UPDATED	User (/components/schema/UserUpdatedWebHookEvent)	A user has been updated.	GA (general available)
USER_DELETED	User (/components/schema/UserDeletedWebHookEvent)	A user has been deleted.	GA (general available)
SERVICE_JOB_CREATED	ServiceJob (/components/schema/ServiceJobCreatedWebHookEvent)	A serviceJob has been created	BETA
SERVICE_JOB_FINISHED	ServiceJob (/components/schema/ServiceJobFinishedWebHookEvent)	A serviceJob has been fnished	BETA
REFUND_TRIGGERED	ItemReturn (/components/schema/RefundTriggeredWebHookEvent)	A refund is triggered	BETA
EXPIRY_ENTITY_CREATED	Expiry(/components/schema/ExpiryWebHookEvent)	An expiry was created. E.g. an order was supplied with a configured expiry.	GA
EXPIRY_ENTITY_UPDATED	Expiry(/components/schema/ExpiryWebHookEvent)	Expiry has updated. You also get an event when the expiry has expired.	GA

The list of available Events available can also be queried from the RESTful API using

curl -sSL 'https://your.api.fulfillmenttools.com/api/supportedevents' \
  --header 'Authorization: Bearer <TOKEN>'

(see https://fulfillmenttools.github.io/api-reference-ui/#/Core%20-%20Eventing/getEvents)

Example: Events during the fulfillment of an order

The following diagram depicts the typical events emitted during a exemplary fulfillment of an order from order routing, via a pick, pack and handover process including a potential return in the future.

You are missing an Event?

Please let us know - we are keen to understand your desire & add the event to our product!