Fluent Commerce Logo
Docs
Sign In

Adding a State to your Workflow

How-to Guide

Author:

Fluent Commerce staff

Changed on:

26 Sept 2023

Key Points

  • It’s possible to add a new state into an existing WorkFlow by adding a new status to the
    `Statuses array`
    of the workflow JSON.

Steps

Step arrow right iconAdding a State to your Workflow

Statuses within the workflow are represented by the white rounded rectangles with a border color matching the lifecycle phase they belong to.

No alt provided

For example, within the Booking phase, the Order status could be:

  • Created
  • Awaiting Payment
  • Fraud Check
  • Booked

Similarly, within each of the other phases, there could be multiple different states in which the entity might travel.


Adding a State via the Workflow JSON

To add a State to a Workflow JSON, you must add a new Status to the 

`statuses`
 array of the Workflow JSON that matches the schema outlined below.

Status schema

JSON Key

Value Type

Mandatory

Description

name

String

YES

Name of the status.

entityType

String

YES

Name of the entity the status belongs to.

category

String

YES

Name of the category the status belongs to.

Status sample
1 {
2  "statuses": [
3    {
4      "name": "{{name}}",
5      "entityType": "{{entityType}}",
6      "category": "{{category}}"
7    }
8  ]
9}

Language: json

Name: Status sample

Description:

[Warning: empty required content area]
Fluent Commerce staff

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.

Fluent Logo