Order Revision Workflow Templates Overview

User action capability is used to revise an Order. It is possible to configure Order Revision functionality via both UI and Postman.

In case there is no Billing Account Flow in the Orchestration, it is necessary to add the workflow via PUT request using Postman.

PUT request:

`https://<ACCOUNT_ID>.<environment>.api.fluentretail.com/api/v4.1/workflow`

Body

Body JSON

Home Delivery (HD) Order workflow

Add the following JSON fragments to the ruleset.

Create Ruleset

Create Ruleset HD JSON

EvaluateRevisedOrder Ruleset

Revised Order Ruleset HD JSON

OrderRevision Ruleset

Order Revision Ruleset HD JSON

NewBillingAccount

New Billing Account HD JSON

ProcessBillingAccount

Process Billing Account HD JSON

OrderCancel

Order Cancel HD JSON

Add the following JSON fragment to the statuses:

1"statuses": [
2    {
3        "name": "",
4        "entityType": "ORDER",
5        "category": "DONE"
6    },
7    {
8        "name": "CREATED",
9        "entityType": "BILLING_ACCOUNT",
10        "category": "BOOKING"
11    },
12    {
13        "name": "",
14        "entityType": "BILLING_ACCOUNT",
15        "category": "DONE"
16    },
17    {
18        "name": "",
19        "entityType": "RETURN_ORDER",
20        "category": "DONE"
21    }
22]

Click and Collect (CC) Order workflow

Add the following JSON fragments to the ruleset:

Create Ruleset

Create Ruleset CC JSON

EvaluateRevisedOrder Ruleset

Revised Order Ruleset CC JSON

OrderRevision Ruleset

Order Revision CC JSON

NewBillingAccount

New Billing Account CC JSON

ProcessBillingAccount

Process Billing Account CC JSON

OrderCancel

Order Cancel CC JSON

Note: `<ACCOUNT_ID>` should be replaced with Account name.

Add the following JSON fragment to the statuses:

1"statuses": [
2    {
3        "name": "",
4        "entityType": "ORDER",
5        "category": "DONE"
6    },
7    {
8        "name": "CREATED",
9        "entityType": "BILLING_ACCOUNT",
10        "category": "BOOKING"
11    },
12    {
13        "name": "",
14        "entityType": "BILLING_ACCOUNT",
15        "category": "DONE"
16    },
17    {
18        "name": "",
19        "entityType": "RETURN_ORDER",
20        "category": "DONE"
21    }
22]

Check if the setting `DEFAULT_TAX_TYPE` exists. If not you need to add it.

Go to Admin > Settings and filter the list of settings by name.

To add a new setting click on Create Setting button and fill the following:

DEFAULT_TAX_TYPE setting

1{
2    "country": "AUS",
3    "group": "STANDARD",
4    "tariff": "GST"
5}

Check if the setting `EXCHANGE_REASON` exists. If not you need to add it.

Go to Admin > Settings and filter the list of settings by name. To add a new setting click on Create Setting button and fill the following:

EXCHANGE_REASON setting

1[
2    {
3    "label": "fc.order.orderRevision.wrong.size",
4    "value": "wrong-size"
5    },
6    {
7    "label": "fc.order.orderRevision.change.mind",
8    "value": "change-mind"
9    },
10    {
11    "label": "fc.order.orderRevision.change.variant",
12    "value": "change-variant"
13    }
14]

Note: Context Id = Retailer Id

Check if the setting `GST` exists. If not you need to add it.

Go to Admin > Settings and filter the list of settings by name. To add a new setting click on Create Setting button and fill the following:

Check if the setting `fc.mystique.search.product.list` exists. If not you need to add it.

Go to Admin > Settings and filter the list of settings by name. To add a new setting click on Create Setting button and fill the following:

fc.mystique.search.product.list setting

Mystique Search Product List Setting JSON

Parameters from which displayed columns can be configured in `fc.mystique.search.product.list` setting:

• imageURL
• Product name
• Product item reference
• Attributes
• Catalogue
• Price

Note: In case `fc.mystique.search.product.list` setting doesn’t exist ‘Add Item’ dialogue will contain only a list of product items and their pictures (default configuration).

'Add Item' dialogue default configuration

Check if the setting `fc.mystique.search.product.query` exists. If not you need to add it.

Go to Admin > Settings and filter the list of settings by name. To add a new setting click on Create Setting button and fill the following:

1{
2    "query": "query products {variantProducts (first: 5, status: \"ACTIVE\")  {edges {node {id catalogue {ref} ref name gtin  summary tax {country group tariff} attributes {name value} categories {edges {node {name}}} prices {type currency value}}}}}"
3}

A base entity for Add item dialog query is VariantProduct. It has references with the following list of entities:

• StandardProduct
• ProductCatalogue
• Category
• Price
• TaxType
• Attribute

Database schema snippet

VariantProduct.graphql file contains max amount of VariantProduct attributes. It is possible to make custom configuration excluding unnecessary attributes.

Note: In case `fc.mystique.search.product.query` setting doesn’t exist ‘Add Item’ dialogue will contain data according to the default configuration.

VariantProduct.graphql file containing a query which returns max amount of VariantProduct attributes.

Order Revision configuration steps:

Use Postman collection to do the following:

• Authenticate using POST request Fluent Auth - Retailer FC_FASHION.
• Get Setting using GET request Get the Retailer settings.
• Get workflow by Retailer Id and Workflow Name using GET request of the same name.
• Create settings (if necessary) using POST requests:
  • Create `DEFAULT_TAX_TYPE` setting
  • Create `EXCHANGE_REASON` setting
  • Create `GST` setting
  • Create `fc.mystique.search.product.list` setting

Post a basic Billing Account workflow (if necessary) using POST request of the same name.