ScheduleFulfilmentCreationForDeliverAfter

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Rule

Changed on:

2 Jan 2024

Overview

The rule schedules an event based on the Shipment’s Delivery From date (fulfilment choice’s

`deliverAfter`

date).

Plugin Name	Order 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.

Order Reference Module

UI Description

Schedules event "eventName" based on the fulfilment choice’s deliverAfter date. If the fc.order.sourcing.reservation.time setting has not been created or if the fulfilment choice’s deliverAfter minus reservation time is less than the current processing time, then send the event without scheduling.

Accepts

FULFILMENT_CHOICE

Actions

This rule schedules event with proper event name based on the fulfilment choice’s deliverAfter date.

Rule parameters

Parameter	Description
eventName	The name of the event to be triggered.

Event attributes

Parameter

Description

Data Type

Required?

fulfilmentChoiceRef

The reference of the

`fulfilmentChoice`

String

Required

Exceptions

This rule does not directly throw any exception.

Configuration example

1{
2  "name":"<ACCOUNTID>.order.ScheduleFulfilmentCreationForDeliverAfter",
3  "props": {
4        "eventName": "anEvent"
5    }
6}

Language: json

Detailed Technical Description

Get
```
`reservationTimeValue`
```
from this event.
If
```
`reservationTimeValue`
```
does exist
- Get a
```
`fulfilmentChoice`
```
  by its ref.
- If the
```
`fulfilmentChoice`
```
  does exist, as well as its
```
`deliverAfter`
```
  field’s value:

i. Get the value of the

`deliverAfter`

of the

`fulfilmentChoice`

ii. Calculate

`wakeupTime: deliverAfter - reservationTimeValue`

iii. If

`currentTime`

is before

`wakeupTime`

- send the

`scheduledEvent`

3. Proceed with the event processing.

Version History

2023-08-03

v1.0.0

refers to plugin