Create an empty Workflow

How-to Guide

Author:

Fluent Commerce staff

Changed on:

1 July 2024

Key Points

A new Workflow creation requires the correct permissions for the user, and a valid workflow JSON file (schema,
```
`entityType`
```
and statuses/rulesets).

Steps

Create an empty Workflow

Before you can create a Workflow you must have a valid Workflow JSON file.

A Workflow requires the following:

a valid schema
a valid
```
`entityType`
```
a "Create" Ruleset and "CREATED" Status for the Rulesets each
```
`entityType`
```
in the Workflow.

Note

The "Create" Ruleset and "CREATED" Status must use those values exactly to be valid.

Workflow schema

JSON Key	Value Type	Mandatory	Description
retailerId	String	YES	Id of the Retailer this Workflow applies to.
version	String	YES	The current version of this Workflow. The initial version is "1.0". Every time you successfully commit an update to a Workflow, the minor version will increment. Major versions can be updated manually.
entityType	String	YES	This field accepts the following inputs: `ORDER` , `LOCATION` , `FULFILMENT_OPTIONS` , `CONTROL_GROUP` , `INVENTORY_CATALOGUE` , `PRODUCT_CATALOGUE` , `VIRTUAL_CATALOGUE` , `RETURN_ORDER` and `BILLING_ACCOUNT` .
entitySubtype	String	YES	A type used to differentiate between multiple Workflows with the same `entityType` . For example, you might have two Workflows for `ORDER` , one that handles Home Delivery, and another that handles BOPIS (Buy Online, Pick up in Store)/ Click & Collect. Some entitySubtypes, such as `CC` and `HD` for `ORDER` , have functionality built into the default Web App Manifest.
description	String	NO	Cannot be more than 300 characters.
versionComment	String	NO	Cannot be more than 2000 characters.
createdBy	String	NO	The name of the last user who changed the Workflow.
createdOn	String	NO	The date and time the Workflow was last changed.
id	String	NO
name	String	NO	The name of the Workflow. If you leave this field blank, the system will generate a name based on the following format: entityType::entitySubtype.
settings	Object	NO	An object of key-value pairs that can enhance the performance and functionality of your Workflow. See available settings here.
rulesets	Array	YES	The array of Rulesets in the Workflow.
statuses	Array	YES	The array of Statuses in the Workflow.

Workflow sample

1{
2    "retailerId": "{{retailerID}}",
3    "version": "1",
4    "entityType": "{{entityType}}",
5    "entitySubtype": "{{entitySubtype}}",
6    "description": "",
7    "versionComment": null,
8    "createdBy": "",
9    "createdOn": "",
10    "id": null,
11    "name": "{{workflowName}}",
12    "settings": {},
13    "rulesets": [
14        {
15            "name": "CREATE",
16            "description": "",
17            "type": "{{entityType}}",
18            "eventType": "NORMAL",
19            "rules": [],
20            "triggers": [
21                {
22                    "status": "CREATED"
23                }
24            ],
25            "userActions": []
26        }
27    ],
28    "statuses": [
29        {
30            "name": "CREATED",
31            "entityType": "{{entityType}}",
32            "category": "{{category}}"
33        }
34    ]
35}

Language: json

Name: Workflow sample

Description:

[Warning: empty required content area]

Fluent Commerce staff

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.

Create an empty Workflow

Key Points

Steps

Create an empty Workflow

Create an empty Workflow

Workflow schema

Workflow sample

Fluent Commerce staff

Building Blocks

By Type

Legal Resources