stringService name for address field
For example: firstname, lastname, country_code and so on.
The field is named with this value in the address forms.
Also the "service-name-{$serviceName}" CSS class is added to the field
viewGetterName
stringGetter name for address field (for AView::getAddressSectionData)
For example:
country for country_code
state for state_id, custom_state
The field is named with this value in the address forms.
Also the "service-name-{$serviceName}" CSS class is added to the field
schemaClass
stringSchema class for "Form field widget".
This class will be used in form widgets
Possible values are:
\XLite\View\FormField\Input\Text
\XLite\View\FormField\Select\Country
\XLite\View\FormField\Select\Title
For more information check "\XLite\View\FormField\*" class family.
The '\XLite\View\FormField\Input\Text' class (standard input text field)
is taken for additional fields by default.
additional
booleanFlag if the field is an additional one (This field could be removed)
required
booleanFlag if the field is a required one
enabled
booleanFlag if the field is an enabled one
position
integerPosition
address
Responses
200Success
Response schema:
Success
id
integerUnique id
value
stringAdditional field value
addressField
object
id
integerUnique id
serviceName
stringService name for address field
For example: firstname, lastname, country_code and so on.
The field is named with this value in the address forms.
Also the "service-name-{$serviceName}" CSS class is added to the field
viewGetterName
stringGetter name for address field (for AView::getAddressSectionData)
For example:
country for country_code
state for state_id, custom_state
The field is named with this value in the address forms.
Also the "service-name-{$serviceName}" CSS class is added to the field
schemaClass
stringSchema class for "Form field widget".
This class will be used in form widgets
Possible values are:
\XLite\View\FormField\Input\Text
\XLite\View\FormField\Select\Country
\XLite\View\FormField\Select\Title
For more information check "\XLite\View\FormField\*" class family.
The '\XLite\View\FormField\Input\Text' class (standard input text field)
is taken for additional fields by default.
additional
booleanFlag if the field is an additional one (This field could be removed)