Fluent Commerce Logo
Docs
Sign In

CreateFulfilment

Rule

Changed on:

25 Oct 2023

Overview

The creates 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.

UI Description

Creates fulfilment based on the incoming proposed fulfilment, excluding fulfilments in statuses {excludedFulfilmentStatuses}. If the "fulfilmentType" parameter is not empty then a fulfilment with this type will be created.

Accepts

  • ORDER

Actions

  • This rule produces an action that triggers a GraphQL createFulfilment mutation

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

The object of a proposed fulfilment.

ProposedFulfilment

Required

Exceptions

This does not explicitly identify any exceptions.

Configuration example

1{
2  "name":"<ACCOUNTID>.order.CreateFulfilment",
3  "props": {
4    "fulfilmentType":"HD_PFS",
5    "excludedFulfilmentStatuses":"CREATED"
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 fulfilment type can 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.3

First release