View Source

Default customer form

Default fiels

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

Default field

Type

Mandatory

Default Validation

Last Name

text

Yes

No

First Name

text

Yes

No

Email

email

Yes

A valid email format is required

Phone Number

tel

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

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

City

text

Yes

No

Postal code

text

Yes

No

This is what the default customer form looks like:

Documentation > Customer form in the Order In Store > {19A20E88-F361-4CCA-A409-544091957D86}-20241213-092018.png

Configuration for default fields

There are specific configurations on the default form:

Put the first name before the surname
Change the list of countries

Add custom fields

Classic fields

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.

text - returns a string
email - returns a string
tel- returns a string
password - returns a string
flip-switch - returns a boolean
list - returns a string or an array of string depending on the ‘multiple’ value

required

boolean

No

Indicates whether the field is mandatory or not. By default, 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.

If I want my field to appear after the country field of the default form : "position_after": "country"
If I want my field to appear at the top of the form : "position_after": ":first"
If I want my field to appear at the bottom of the form, I leave it blank.

validation

object

No

Enables to add custom validation to the field, which will be checked when the create button is clicked.

These 3 types of validation can be configured alone or together.

min_characters (int) - minimum number of characters required
max_characters (int) - maximum number of characters required
regex (string) - Custom regular expression used to verify the field. More information Here.

Require a 5-digit postcode

"validation": {
  "min_characters": 5,
  "max_characters": 5
}

Use a custom validation for UK postcode

"validation": {
  "regex": "^([a-zA-Z]){1}([0-9][0-9]|[0-9]|[a-zA-Z][0-9][a-zA-Z]|[a-zAZ][0-9][0-9]|[a-zAZ][0-9]|[0-9][a-zAZ]){1}([ ])*([0-9][a-zA-z][a-zA-z]){1}$"
}

Regexes with ‘\’ must escape by doubling it "\\"

Fields if the field is a list

Field

Type

Mandatory

Description

options

array[string]

No

List of values displayed in the drop down.

Options inside will be translated with the key crm.information._{name}_options.{option}

List of options for the title custom field

"options": [
    "MR",
    "MRS"
],

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.

Change classic fields

Request entries

Regarding the address:
- address_1 - sent in the customer.addresses.[0].lines.[0] field of the POST /customers query
- address_2 - sent in the customer.addresses.[0].lines.[1] field of the POST /customers query
- city - sent in the customer.addresses.[0].city field of the POST /customers query
- zip_code - sent in the customer.addresses.[0].zip_code field of the POST /customers query
- country - sent in the customer.addresses.[0].regions.country.code field of the POST /customers query
Regarding the contact - sent in the customer.addresses.[0].contact AND customer.contact fields of the POST /customers query
- title
- first_name
- last_name
- phone_number
- email
- company_name
- mobile_number
Regarding custom information
- information.{custom_field} sent in the customer.addresses.[0].information field if target = address / sent in the customer.contact field if target = address
- external_id sent in the customer.external_id field. The target need to be set as customer.

Please note, the label of the field will be translated based on the translation key crm.<name>.

External CRM

External CRM may raised error (exemple email adress/phone number already used).
If so, project interface MUST return a 409 error including:

field that is the field related to the conflit. Value MUST be email or phone_number
message which is the error message to display in the interface

The error message will be display on the form.