Create an empty Workflow
How-to Guide
Author:
Fluent Commerce
Changed on:
5 Sept 2025
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
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.
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 Workflow settings or how to add Settings to a Workflow. |
| rulesets | Array | YES | The array of Rulesets in the Workflow. |
| statuses | Array | YES | The array of Statuses in the Workflow. |
