Skip to main content

Add new address field

Add new address field

Authorizations:Token
Request Body Schema:
AddressField object that needs to be added
idintegerUnique id
serviceNamestringService 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
viewGetterNamestringGetter 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
schemaClassstringSchema 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.
additionalbooleanFlag if the field is an additional one (This field could be removed)
requiredbooleanFlag if the field is a required one
enabledbooleanFlag if the field is an enabled one
positionintegerPosition

Responses

200Success
Response schema:
Success
idintegerUnique id
serviceNamestringService 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
viewGetterNamestringGetter 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
schemaClassstringSchema 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.
additionalbooleanFlag if the field is an additional one (This field could be removed)
requiredbooleanFlag if the field is a required one
enabledbooleanFlag if the field is an enabled one
positionintegerPosition