CancelFulfilment

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Rule

Changed on:

8 Aug 2025

Overview

The rule changes the status of the incoming fulfilment to 'CANCELLED' and updates fulfilment item's filled and rejected quantities.

Plugin Name	Core Reference Module
Namespace	[[account.id]].core

The Core Reference Module is a foundational Reference Module. It provides a base set of general purpose Rules:

that other Modules are built upon
or that can be included in your own Workflows

Extensible by design, use this Module as a base to build a solution for the needs of your customers.

Core Reference Module

The Core Reference Module is a foundational Reference Module. It provides a base set of general purpose Rules:

that other Modules are built upon
or that can be included in your own Workflows

Extensible by design, use this Module as a base to build a solution for the needs of your customers.

UI Description

Changes the status of the incoming fulfilment to 'CANCELLED' and updates fulfilment item's filled and rejected quantities. Filled quantity is set to 0 and the rejected quantity is set to requested quantity.

Accepts

FULFILMENT

Actions

This rule performs an update mutation on the fulfilment entity.

Rule parameters

This rule does not identify any input parameters.

Event attributes

This rule does not directly identify any event attributes.

Exceptions

This rule will throw an RubixException: 400 if no fulfilment is found.

Configuration example

1{
2  "name": "<ACCOUNTID>.order.CancelFulfilment",
3  "props": {}
4}

Detailed Technical Description

Getting fulfilment from context.
Set fulfilment status to `CANCELLED`.
Get items from fulfilment:
-`filledQuantity` is set to 0
-`rejectedQuantity` is set to requested quantity

Version History

2023-08-03

v1.0.1

refers to the plugin