Fluent Commerce Logo
Docs
Sign In

CreateParcelsForFulfilment

Rule

Changed on:

2 Oct 2024

Overview

This rule is executed to create articles based on the items packed into parcels.

Plugin NameOrder Reference Module
Namespace[[account.id]].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

Create parcels from details on the event attribute articles

Accepts

  • Fulfilment

Actions

  • This Rule produces a createArticle 
    `MutateAction`

Event attributes

Parameter

Description

Data Type

Required?

packedItems

The list of packed and rejected fulfilment items

Object

Required

Exceptions

This rule may result in the following exceptions:

  • All generated exceptions will be wrapped with RubixException: 400;
  • Throw
    `IllegalArgumentException`
    if an incoming event has no
    `packedItems`
    attribute.

Configuration example

1{
2  "name": "[[account.id]].order.CreateParcelsForFulfilment",
3  "props": null
4}

Language: json

Detailed Technical Description

This rule gets the

`packedItems`
attribute from the event. After that, the rule creates one or more parcels(articles) based on the information from the '
`packedItems.articles`
’ attribute if they are not empty. 

1{"packedItems": {
2  "articles": [
3      {
4        "packaging_name": "small",
5        "length": "18",
6        "width": "18",
7        "height": "18",
8        "weight": "3",
9        "maxWeight": "4",
10        "items": [
11          {
12            "fulfilmentItemId": 33,
13            "quantity": 2
14          },
15          {
16            "fulfilmentItemId": 34,
17            "quantity": 1
18          }
19        ]
20      }
21    ]
22    }
23}

Language: json

Name: Example of 'packedItems.articles' attribute:

Description:

[Warning: empty required content area]
Workflow Builder (Modeller) Screenshot
No alt provided

Version History

2024-10-08

v1.0.0

Initial release

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