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 |
---|---|---|
ORDER_CREATED | Order ( | An order has been created. |
ORDER_CANCELLED | Order ( | An order has been cancelled. |
ORDER_UNLOCKED | Order ( | An order has been unlocked. |
INVENTORY_FACILITY_STOCK_CHANGED | InventoryFacilityStock ( | The aggregated stock availability of one product (identified by its |
INBOUND_DELIVERY_RECEIVED | InboundDeliveryReceived ( | A new receipt was created, indicating accepting new stock into the facility. |
INBOUND_DELIVERY_FINISHED | InboundDeliveryFinished ( | A new receipt was created and the corresponding inbound process was completed, meaning theamount of received items for each requested line item is reached or exceeded. |
INBOUND_DELIVERY_ON_HOLD | InboundDeliveryOnHoldPayload ( | An inbound process was placed on hold by setting the onHold flag to true. |
INBOUND_DELIVERY_RELEASED | InboundDeliveryFinished ( | An inbound process was released from onHold status by setting the onHold flag to false. |
ROUTING_PLAN_SPLITTED | RoutingPlan( | A routing plan has been split into multiple parts. |
ROUTING_PLAN_WAITING | RoutingPlan ( | A routing plan is waiting for external events in order to get routed. |
ROUTING_PLAN_FALLBACK | RoutingPlan ( | A routing plan has been routed to its fallback facility. |
ROUTING_PLAN_ROUTED | RoutingPlan ( | A routing plan has been routed successfully. |
ROUTING_PLAN_REROUTEPLAN_CREATED | RoutingPlan( | A reroute plan has been created for a routing plan |
ROUTING_PLAN_NOT_ROUTABLE | RoutingPlan ( | An order could not be routed. The routing plan that was used is attached. |
FACILITY_CREATED | Facility ( | A facility has been created. |
FACILITY_UPDATED | Facility ( | A facility has been updated. |
FACILITY_DELETED | Facility ( | A facility has been deleted. |
PICK_JOB_CREATED | Pickjob ( | A pick job has been created. |
PICK_JOB_PICKING_COMMENCED | Pickjob( | A pick job is being picked. |
PICK_JOB_PICKING_PAUSED | Pickjob ( | A pick job has been paused. |
PICK_JOB_PICKING_FINISHED | Pickjob ( | A pick job was finished. |
PICK_JOB_PICK_LINE_PICKED | Pickjob ( | A pick line of a pick job has been picked. |
PICK_JOB_REROUTED | Pickjob ( | A pick job has been rerouted to another facility. |
PICK_JOB_RESET | Pickjob ( | A pick job has been reset. |
PICK_JOB_ABORTED | Pickjob ( | A pick job has been aborted because nothing was picked. |
PACK_JOB_CREATED | Packjob ( | A new pack job has been created. |
PACK_JOB_UPDATED | Packjob ( | A pack job was updated. |
HANDOVERJOB_CREATED | Handoverjob ( | A handover job has been created. |
HANDOVERJOB_HANDED_OVER | Handoverjob( | A handover job has been handed over. |
HANDOVERJOB_REVERTED | Handoverjob( | This event is published, when a handover job is set back to |
HANDOVERJOB_CANCELED | Handoverjob( | A handover job has been canceled. |
PARCEL_CARRIER_REQUESTED | Parcel( | FFT platform started processing of the parcel. |
PARCEL_CARRIER_FAILED | Parcel( | The label could not be created. |
PARCEL_CARRIER_ACKNOWLEDGED | Parcel( | The label was successfully created and the label can now be downloaded. |
RETURN_CREATED | Return ( | Return has been created. |
RETURN_CLAIMED | Return ( | Return has been claimed. |
RETURN_CLOSED | Return ( | Return has been closed. |
RETURN_CANCELED | Return ( | Return has been canceled. |
RETURN_UPDATED | Return ( | Return has been updated. |
SHIPMENT_CREATED | Shipment ( | Shipment has been created. |
SHIPMENT_UPDATED | Shipment ( | Shipment has been updated. |
USER_CREATED | User | A user has been created. |
USER_UPDATED | User | A user has been updated. |
USER_DELETED | User | A user has been deleted. |
The list of available Events available can also be queried from the RESTful API using
(see https://fulfillmenttools.github.io/api-reference-ui/#/Eventing/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!
Last updated