Fluent Commerce Logo
Docs
Sign In

Extended Address Input

UI Component

Changed on:

7 Sept 2023

Overview

`ExtendedAddressInput`
 is a Mystique component that can support the extended address in order details and a digital/e-mail shipping method. The component supports delivery addresses with lengthy street/city/company name fields (255 characters).

Plugin NameCore

The standard library of mystique components. 

0000-00-00

v1.0.0

Initial changelog entry.

Alias

ExtendedAddressInput

Detailed technical description

Configuration

Step 1. Configure Workflow:

  • A series of guides covering building Workflow is available here.
1"rulesets": [        
2  {            
3    "name": "OrderAddressChange",            
4    "description": "Order address is changed from admin console",            
5    "type": "ORDER",            
6    "subtype": "HD",            
7    "eventType": "NORMAL",            
8    "rules": [                
9      {                    
10        "name": "<ACCOUNTID>.order.ChangeOrderDeliveryAddress",                     
11        "props": null                
12      }            
13    ],            
14    "userActions": [                
15      {                    
16        "attributes": [                        
17          {                            
18            "name": "deliveryAddress",                            
19            "label": "Address",                            
20            "type": "EXTENDEDADDRESS",                             
21            "source": "",                            
22            "defaultValue": "",                            
23            "mandatory": false                        
24            }                    
25          ]                
26        }            
27      ]        
28    }    
29  ]
30}

Language: json

Name: Example

Description:

[Warning: empty required content area]

Step 2. Configure Manifest (

`fc.mystique.manifest.oms.fragment.ordermanagement`
):

  • Extend 
    `deliveryAddress`
     in the query on the Order Details page with street2 and email;
  • Set default values for 
    `deliveryAddress`
    . See Sample Manifest below.

Properties

None

Configuration example

1{
2  "type": "userAction",
3  "name": "OrderAddressChange",                                    
4  "overrides": {                                        
5    "deliveryAddress": {                                            
6      "defaultValue": {                                                
7        "companyName": "{{orderById.fulfilmentChoice.deliveryAddress.companyName}}",                                                
8        "name": "{{orderById.fulfilmentChoice.deliveryAddress.name}}",
9        "email": "{{orderById.fulfilmentChoice.deliveryAddress.email}}",                                                
10        "street": "{{orderById.fulfilmentChoice.deliveryAddress.street}}",                                                
11        "street2": "{{orderById.fulfilmentChoice.deliveryAddress.street2}}",                                                                                            
12        "city": "{{orderById.fulfilmentChoice.deliveryAddress.city}}",                                                
13        "postcode": "{{orderById.fulfilmentChoice.deliveryAddress.postcode}}",                                                
14        "state": "{{orderById.fulfilmentChoice.deliveryAddress.state}}",                                                
15        "country": "{{orderById.fulfilmentChoice.deliveryAddress.country}}"                                            
16      }                                        
17    }                                    
18  }                                
19}

Language: json

Version History

0000-00-00

v1.0.0

Initial changelog entry.

Recommended Placement

This component was designed to be used on order details page.

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