CancelFulfilment

Rule

Changed on:

27 Nov 2023

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	{{accountId}}.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

Overview

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.

Features

General purpose Rules to power your Workflows

Change the state of an entity
Send an event to trigger a Ruleset for the same entity
Send a Webhook
Create conditional logic based on the value or presence of a property

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}

Language: json

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

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.