Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Adding a Workflow to your Retailer via API

Essential knowledge

Author:

Fluent Commerce staff

Changed on:

24 Oct 2023

Overview

this page is to show how to add a new workflow to your Retailer via the API Put method.

Key points

Ensure the user has the right Permissions before executing the API.
How to add a Workflow to your Retailer via API

Adding a Workflow to your Retailer via API

Permissions

The user needs

`WORKFLOW_CREATE`

, and

`WORKFLOW_UPDATE`

permissions to add a new Workflow. These permissions are included in the

`ORCHESTRATION_ADMIN`

role.

How to add a Workflow to your Retailer via API

To add a new Workflow to your Fluent Account, send your valid Workflow JSON to the following URL via the

`PUT`

method.

`https://{{accountID}}.{{environment}}.api.fluentretail.com/api/v4.1/workflow`

Warning

Never use the

`POST`

method, even when creating a Workflow for the first time. The

`POST`

method does not validate the Workflow. Instead, use

`PUT`

.

Note

You will need to provide an Auth header to add the Workflow via the API.

Note

If you intend to use a production environment, remove the

`{{environment}}`

from your URL.

Sample successful update response

If your request was successful, you should receive the following response:

1{
2    "entityId": "{{retailerID}}-{{workflowName}}::{{workflowVersion}}",
3    "eventStatus": "COMPLETE"
4}

Language: json

Name: Response Example

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.

Adding a Workflow to your Retailer via API

Overview

Key points

Adding a Workflow to your Retailer via API

Permissions

How to add a Workflow to your Retailer via API

Sample successful update response

Fluent Commerce staff

Building Blocks

By Type

Legal Resources