Customer form in the Order In Store

1 Default customer form
- 1.1 Default fields
- 1.2 Specific configurations on the default form
2 Address autocomplete
3 Add custom fields
- 3.1 Custom fields structure
- 3.2 In case of lists
- 3.3 Examples
4 Edit default fields parameters
- 4.1 Examples
5 Customer creation request

Default customer form

Default fields

By default, when the catalogue is activated, a standard form is proposed with the following fields:

Default field	Type	Mandatory	Default Validation

Default field	Type	Mandatory	Default Validation
Last Name	text	Yes	No
First Name	text	Yes	No
Email	email	Yes	Yes A valid email format is required
Phone Number	tel	Yes	Yes The phone index corresponding to the store's country is automatically proposed. It can, however, be changed manually. Validation is then carried out according to the selected index, respecting the national rules.
Country	list	Yes	Yes The country code corresponding to the store's country is automatically selected. It can, however, be changed manually. By default, the list proposes the following countries: France, Belgium, Germany, Italy, Luxembourg, Spain, Switzerland, United Kingdom. This list can be overwritten, see section below.
Address 1	text	Yes	No
Address 2	text	No	No
City	text	Yes	No
Postal code	text	Yes	No

This is what the default customer form looks like:

Specific configurations on the default form

Invert the position of the first and last names: so that the first name appears first and the last name second, you need to add the configuration "customer.invert_names" : true in the Configuration > Store App > Pages > Catalog > Specific settings page in the Options section.
{ "customer": { "invert_names": true } }

Change the list of countries:

The default form proposes the following countries: France, Belgium, Germany, Italy, Luxembourg, Spain, Switzerland, United Kingdom. An override can be made per sales channel using the configuration "countries.{sales_channel}.{list of countries}" in the Configuration > Store App > Pages > Catalog > Specific settings page in the Options section.

Country codes must be in ISO-3166 format. Logos and translations will add themselves in the Store App.

{
    "countries": {
        "sc_ois_1": [
            "FR",
            "CH"
            "GB"
        ]
    }
}

Address autocomplete

To streamline address entry and ensure accuracy, you can activate the autocomplete module. Powered by Google, this feature provides instant address suggestions as you type, helping to automatically populate fields such as street name, number, city, and postal code. Address suggestions are limited to the country selected above.

Please note:

This feature requires the activation of an additional module. To activate it, a specific contractual agreement is required, involving an additional cost per order placed through Order In Store.

For more information, please reach out to our sales team or your account manager.

Add custom fields

You can take personnalisation a step further by adding custom fields to the customer form. To do this, add the required fields to the configuration customer.custom_fields.{sales_channel}[{custom_fields_structure}] in the Configuration > Store App > Pages > Catalog > Specific settings page in the Options section.

If the fields added are to be applied to all the project's sales channels, then the field "_ALL_" must be given in the {sales_channel} part.

Here is a configuration applied to all the sales channels with ... being the structure of the custom fields that we will see below.

{
    "customer": {
        "custom_fields": {
            "_ALL_": [
                {
                  ...
                }
            ]
        }
    }
}

Custom fields structure

Inside the {sales_channel} entity ( or "_ALL_") there is an array of objects. Each object corresponds to a custom field to be added to the form. Here is the configuration to be entered for each custom field.

Field	Type	Mandatory	Description

Field	Type	Mandatory	Description
`name`	string	Yes	This key is used to give the identifier of the field. This id must match with parameters used in `POST /customers` request or `PATCH /customers/<id>` Contact fields: `title`, `first_name`, `last_name`, `phone_number`, `email`, `company_name`, `mobile_number` Address fields: `address_1`, `address_2`, `address_3`, `city`, `zip_code`, `country` Custom fields: `information.{custom_field}`, `external_id`
`target`	string	No	Indicates whether the field should be saved in the `customer` structure or the `address` structure. By default, `customer` is applied. Only used for `information.{custom_field}` and `external_id` names, the others are automatically redirected to the right structure. `customer` `address`
`type`	string	No	Type of the field. By default, the `text` type is used.
`required`	boolean	No	Indicates whether the field is mandatory or not. By default, custom fields are optional.
`position_after`	string	No	This key defines the name of the form element to which it must be placed after. Please note, the form element must be in the default form or declared before in the same form. It it also possible to place the element on the top of the form with the value `:first`. If multiple elements are placed in first position, they will be placed in the order in which they are configured. If not defined, the element form will be placed at the bottom of the form.
`validation`	object	No	Enables to add custom validation to the field, which will be checked when the create button is clicked. Regexes with ‘\’ must escape by doubling it "\\"

In case of lists

If the type of field added is a list, then additional configurations must be added inside the structure.

Field	Type	Mandatory	Description

Field	Type	Mandatory	Description
`options`	array[string]	Yes	List of values displayed in the drop down. Options inside will be translated with the key `crm.information._{name}_options.{option}`
`multiple`	bool	No	Indicates if multiple selection can be done.
`searchable`	bool	No	Indicates if drop down elements are searchable.
`initial_value`	string	No	Indicates the pre-selected option.

Examples

Edit default fields parameters

The form's default fields cannot be deleted, but they can be modified. To do this, just configure these fields in the same configuration as custom fields using the same configuration structure. It is essential that the field name configured corresponds to the name of the default fields given above.

Examples

Customer creation request

Once the customer form has been completed and validated, a call will be made to the POST/customers route. If an external CRM has been configured, the call will be directly made to this external CRM.

An external CRM may generate errors (e.g., email address or phone number already existing in the database).
In such cases, the external CRM must return a 409 error containing:

field - form field in error
message - error message to display

Then, the error message will be display on the form.