Fluent Commerce Logo
Docs
Sign In

CancelAllFulfilmentsForOrder

Rule

Changed on:

27 Nov 2023

Overview

The rule changes the status of all fulfilments associated with the incoming order entity to 

`CANCELLED`
 and updates fulfilment item's filled quantity and rejected quantity.

Plugin NameOrder Reference Module
Namespace{{accountId}}.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

Cancels all related fulfilments that belong to cancel order.

Accepts

  • ORDER

Actions

  • This rule produces an action with triggers the updateFulfilment mutation.

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 fulfillment or order entities are not found.

Configuration example

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

Language: json

Detailed Technical Description

  • Read incoming event: 
    `accountId, orderId`
  • Getting order with fulfilments by order id via GQL query and null check (potential exception 1)
  • For each fulfilment in the order
    • For each item in the fulfilment item is added in the 
      `UpdateFulfilmentItemWithFulfilmentInput`
       list with filled quantity and rejected quantity
    • Changing status to 
      `CANCELLED`
    • Check that 
      `UpdateFulfilmentItemWithFulfilmentInput`
       list is not empty
    • Updating fulfilment with 
      `UpdateFulfilmentItemWithFulfilmentInput`
       list and 
      `CANCELLED`
       status via GQL mutation

Version History

2023-08-03

v1.0.0

refers to 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.

Fluent Logo