CreateFulfilment
Changed on:
8 Aug 2025
Overview
The rule creates fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.
| Plugin Name | Order Reference Module |
|---|---|
| Namespace | [[account.id]].order |
The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.
UI Description
Creates fulfilment based on the incoming proposed fulfilment, excluding fulfilments in statuses {excludedFulfilmentStatuses}. If the "fulfilmentType" parameter is not empty then a fulfilment with this type will be created.
Accepts
- ORDER
Actions
- This rule produces an action that triggers a GraphQL createFulfilment mutation
Rule parameters
Parameter | Description |
excludedFulfilmentStatuses | The list of excluded fulfilment statuses. |
fulfilmentType | The type of the fulfilment. |
Event attributes
Parameter | Description | Data Type | Required? |
proposedFulfilment | The object of a proposed fulfilment. | ProposedFulfilment | Required |
Exceptions
This rule does not explicitly identify any exceptions.
Configuration example
1{
2 "name":"<ACCOUNTID>.order.CreateFulfilment",
3 "props": {
4 "fulfilmentType":"HD_PFS",
5 "excludedFulfilmentStatuses":"CREATED"
6 }
7}Detailed Technical Description
Extension
If you are using Click and Collect, Home Delivery or Mixed Baskets reference workflows, following fulfilment types can be used without additional rule modification.
`CC_PFS` for Click & Collect - Pick from Store
`CC_PFDC` for Click & Collect - Pick from DC
`HD_PFS` for Home Delivery - Pick from Store
`HD_PFDC` for Home Delivery - Pick from DC
If you create your own fulfilment type and would like it to be supported in our reference workflow, you need to set the custom type in the `fulfilmentType` field and update the workflow so the new fulfilment type can be processed.
Useful information:
