CreateFulfilmentForFulfilmentChoiceForUnfulfillableItems
Rule
Changed on:
8 Aug 2025
Overview
The rule creates a rejected fulfilment for order items that could not be fulfilled (no inventory) based on location. The rule processes only fulfilments that are in accepted statuses and not in rejected 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 |
UI Description
Creates a rejected fulfilment for order items that could not be fulfilled (no inventory) based on location from "systemRejectedLocationRef". The rule processes only fulfilments which are in accepted statuses from "acceptedStatuses" and not in rejected statuses from "rejectedStatuses". If the "fulfilmentType" parameter is not empty then a fulfilment with this type will be created.
Accepts
- FULFILMENT_CHOICE
Actions
- Creates a rejected fulfilment for order items that could not be fulfilled (no inventory) using location, accepted statuses and rejected statuses
Rule parameters
| Parameter | Description |
| systemRejectedLocationRef | The value of the location to be used in the new rejected fulfilment. |
| acceptedStatuses | The list of statuses in which fulfilments will be processed by the rules. |
| rejectedStatuses | The list of statuses in which fulfilments will not be processed by the rules. |
| fulfilmentType | The type of the fulfilment. |
Event attributes
| Parameter | Description | Data Type | Required? |
| fulfilmentChoiceRef | Reference to the fulfilment choice | String | Required |
Exceptions
This rule will throw an IllegalArgumentException
- if invalid fulfilment choice type
- if invalid location type
- if invalid
`acceptedStatuses`, must not be empty - if invalid
`rejectedStatuses`, must not be empty - if found a fulfilment status in both
`acceptedStatuses`and`rejectedStatuses`lists
Configuration example
1{
2 "name": "<ACCOUNTID>.order.CreateFulfilmentForFulfilmentChoiceForUnfulfillableItems",
3 "props": {
4 "fulfilmentType":"HD_PFS",
5 "systemRejectedLocationRef":"{{escalationLocation}}",
6 "acceptedStatuses":"[{{acceptedFulfilmentStatuses}}]",
7 "rejectedStatuses":"[{{rejectedFulfilmentStatuses}}]"
8 }
9}Detailed Technical Description
Extension
If you are using Click and Collect, Home Delivery or Mixed Baskets reference workflows, the 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 DCIf 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: