Fluent Commerce Logo
Docs
Sign In

CreateFulfilmentForFulfilmentChoice

Rule

Changed on:

13 Nov 2023

Overview

The creates a 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 NameOrder Reference Module
Namespace[[account.id]].order

The is the foundation for order-related implementations. It provides reference workflows for , 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 a fulfilment based on the incoming proposed fulfilment, excluding fulfilments in statuses from "excludedFulfilmentStatuses". If the "fulfilmentType" parameter is not empty then a fulfilment with this type will be created.

Accepts

  • FULFILMENT_CHOICE

Actions

  • Creates a fulfilment based on in coming proposed fulfilment, excluding fulfilments in proper excluded statuses

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

List of proposed fulfilments

String

Required

fulfilmentChoiceRef

Reference to the fulfilment choice

String

Required

Exceptions

This may result in following exceptions:

RubixException: 400, "Invalid fulfilment choice type"

Configuration example

1{
2  "name": "<ACCOUNTID>.order.CreateFulfilmentForFulfilmentChoice",
3    "props": {
4        "fulfilmentType":"HD_PFS",
5        "excludedFulfilmentStatuses": "fulfilmentStatuses"
6    }
7}

Detailed Technical Description

Extension

If you are using Click and Collect, or Mixed Baskets reference workflows, following fulfilment types can be used without additional modification.

`CC_PFS` for -

`CC_PFDC` for - Pick from DC

`HD_PFS` for -

`HD_PFDC` for - Pick from DC

If you create your own fulfilment type and would like it to be supported in our reference , you need to set the custom type in the `fulfilmentType` field and update the so the new type could be processed.

Useful information:

  • A guide about uploading and installing plugins with modified rules is available here;
  • The Workflow Engine overview is available here.

Version History

2023-08-04

v1.0.1

refers to