OK - Available Events
Last updated
Last updated
The list of available Events can be queried from the RESTful API using /api/supportedevents. An overview of all events are listed below.
You are missing an Event?
Please let us know - we are keen to understand your desire & add the event to our product!
The payload models can be found in our fulfillmenttools OpenAPI specification.
Event | Information | API Lifecycle |
---|---|---|
UPCOMING_TIME_TRIGGERED_REROUTE
Description
A time triggered reroute is imminent.
Payload Model
UpcomingTimeTriggeredRerouteWebHookEvent
GA
EXTERNAL_ACTION_EXECUTED
Description
An external action was executed.
Payload Model
ExternalActionExecutedWebHookEvent
GA
ORDER_CREATED
Description
An order has been created.
Payload Model
OrderCreatedWebHookEvent
GA
ORDER_CANCELLED
Description
An order has been cancelled.
Payload Model
OrderCancelledWebHookEvent
GA
ORDER_UNLOCKED
Description
An order has been unlocked.
Payload Model
OrderUnlockedWebHookEvent
GA
ORDER_FORCE_CANCELLED
Description
An order has been force cancelled.
Payload Model
OrderForceCancelledWebHookEvent
GA
INVENTORY_FACILITY_STOCK_CHANGED
Description
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.
Payload Model
InventoryFacilityStockChangedWebHookEvent
GA
INBOUND_DELIVERY_RECEIVED
Description
A new receipt was finished, indicating that new stock was accepted in the facility.
Payload Model
InboundDeliveryReceivedWebHookEvent
GA
INBOUND_DELIVERY_FINISHED
Description
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.
Payload Model
InboundDeliveryFinishedWebHookEvent
GA
INBOUND_DELIVERY_ON_HOLD
Description
An inbound process was placed on hold by setting the onHold flag to true. This means the process should be paused for now.
Payload Model
InboundDeliveryOnHoldWebHookEvent
GA
INBOUND_DELIVERY_RELEASED
Description
An inbound process was released from onHold status by setting the onHold flag to false. This means the process can be continued.
Payload Model
InboundDeliveryReleasedWebHookEvent
GA
ROUTING_PLAN_SPLITTED
Description
A routing plan has been split into multiple parts.
Payload Model
RoutingPlanSplittedWebHookEvent
GA
ROUTING_PLAN_WAITING
Description
A routing plan is waiting for external events in order to get routed.
Payload Model
RoutingPlanWaitingWebHookEvent
GA
ROUTING_PLAN_FALLBACK
Description A routing plan has been routed to its fallback facility. Payload Model
GA
ROUTING_PLAN_ROUTED
Description
A routing plan has been routed successfully.
Payload Model
RoutingPlanFallbackRoutingWebHookEvent
GA
ROUTING_PLAN_CANCELLED
Description
A routing plan has been cancelled.
Payload Model
WebHookEvent
with RoutingPlan
as payload
GA
ROUTING_PLAN_REROUTEPLAN_CREATED
Description
A reroute plan has been created for a routing plan.
Payload Model
RoutingPlanRerouteCreatedWebHookEvent
GA
ROUTING_PLAN_NOT_ROUTABLE
Description
An order could not be routed. The routing plan that was used is attached.
Payload Model
RoutingPlanNotRoutableWebHookEvent
GA
FACILITY_CREATED
Description
A facility has been created.
Payload Model
FacilityCreatedWebHookEvent
GA
FACILITY_UPDATED
Description
A facility has been updated.
Payload Model
FacilityUpdatedWebHookEvent
GA
FACILITY_DELETED
Description
A facility has been deleted.
Payload Model
FacilityDeletedWebHookEvent
GA
PICK_JOB_CREATED
Description
A pick job has been created.
Payload Model
PickJobCreatedWebHookEvent
GA
PICK_JOB_PICKING_COMMENCED
Description
A pick job is being picked.
Payload Model
PickjobPickingCommencedWebHookEvent
GA
PICK_JOB_PICKING_PAUSED
Description
A pick job has been paused.
Payload Model
PickjobPickingPausedWebHookEvent
GA
PICK_JOB_PICKING_FINISHED
Description
A pick job was finished.
Payload Model
PickjobPickingFinishedWebHookEvent
GA
PICK_JOB_PICK_LINE_PICKED
Description
A pick line of a pick job has been picked.
Payload Model
PickJobPickLinePickedWebHookEvent
GA
PICK_JOB_REROUTED
Description
A pick job has been rerouted to another facility.
Payload Model
WebHookEvent
with PickJob
as payload
GA
PICK_JOB_RESET
Description
A pick job has been reset.
Payload Model
WebHookEvent
with PickJob
as payload
GA
PICK_JOB_ABORTED
Description
A pick job has been aborted because nothing was picked.
Payload Model
PickjobPickingAbortedWebHookEvent
GA
PICK_JOB_CANCELED
Description
A pick job has either been directly canceled or its order has been canceled.
Payload Model
PickjobPickingCanceledWebHookEvent
GA
PACK_JOB_CREATED
Description
A new pack job has been created.
Payload Model
PackJobCreatedWebHookEvent
GA
PACK_JOB_UPDATED
Description
A pack job was updated.
Payload Model
PackJobUpdatedWebHookEvent
GA
PACK_JOB_CANCELED
Description
A packJob has either been directly canceled or its pickJob has been canceled.
Payload Model
PackjobPackingCanceledWebHookEvent
GA
PACK_JOB_CLOSED
Description
Packing of a PackJob has finished and it was set to CLOSED
.
Payload Model
PackjobPackingClosedWebHookEvent
GA
HANDOVERJOB_CREATED
Description
A handover job has been created.
Payload Model
HandoverJobCreatedWebHookEvent
GA
HANDOVERJOB_HANDED_OVER
Description
A handover job has been handed over.
Payload Model
HandoverJobHandedOverWebHookEvent
GA
HANDOVERJOB_REVERTED
Description
This event is published, when a handover job is set back to OPEN
manually.
Payload Model
HandoverJobRevertedWebHookEvent
GA
HANDOVERJOB_CANCELED
Description
A handover job has been canceled.
Payload Model
HandoverJobCanceledWebHookEvent
GA
PARCEL_CARRIER_REQUESTED
Description
FFT platform started processing of the parcel.
Payload Model
ParcelCarrierRequestedWebHookEvent
GA
PARCEL_CARRIER_FAILED
Description
The label could not be created.
Payload Model
ParcelCarrierFailedWebHookEvent
GA
PARCEL_CARRIER_ACKNOWLEDGED
Description
The label was successfully created and the label can now be downloaded.
Payload Model
ParcelCarrierAcknowledgedWebHookEvent
GA
ITEM_RETURN_JOB_CREATED
Description
ItemReturnJob has been created.
Payload Model
WebHookEvent
with ItemReturnJob
as payload
GA
ITEM_RETURN_JOB_UPDATED
Description
ItemReturnJob has been updated.
Payload Model
WebHookEvent
with ItemReturnJob
as Payload
GA
RETURN_CANCELED
Description
Return has been canceled.
Payload Model
ReturnJobCanceledWebHookEvent
GA
RETURN_CLAIMED
Description
Return has been claimed.
Payload Model
ReturnJobClaimedWebHookEvent
GA
RETURN_CLOSED
Description
Return has been closed.
Payload Model
ReturnJobClosedWebHookEvent
GA
RETURN_CREATED
Description
Return has been created.
Payload Model
ReturnJobCreatedWebHookEvent
GA
RETURN_UPDATED
Description
Return has been updated.
Payload Model
WebHookEvent
with ReturnJob
as payload
GA
SHIPMENT_CREATED
Description
Shipment has been created.
Payload Model
ShipmentCreatedWebHookEvent
GA
SHIPMENT_UPDATED
Description
Shipment has been updated.
Payload Model
ShipmentUpdatedWebHookEvent
GA
USER_CREATED
Description
A user has been created.
Payload Model
UserCreatedWebHookEvent
GA
USER_UPDATED
Description
A user has been updated.
Payload Model
UserUpdatedWebHookEvent
GA
USER_DELETED
Description
A user has been deleted.
Payload Model
UserDeletedWebHookEvent
GA
SERVICE_JOB_CREATED
Description
A serviceJob has been created.
Payload Model
ServiceJobCreatedWebHookEvent
BETA
SERVICE_JOB_FINISHED
Description
A serviceJob has been fnished.
Payload Model
ServiceJobFinishedWebHookEvent
BETA
REFUND_TRIGGERED
Description
A refund is triggered.
Payload Model
RefundTriggeredWebHookEvent
BETA
EXPIRY_ENTITY_CREATED
Description
An expiry was created. E.g. an order was supplied with a configured expiry.
Payload Model
ExpiryWebHookEvent
GA
EXPIRY_ENTITY_UPDATED
Description
Expiry has updated. You also get an event when the expiry has expired.
Payload Model
ExpiryWebHookEvent
GA