GET
Retrieve address fields by conditions

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\AddressField>[] array
Sample response
[{"id":33,"serviceName":"example","viewGetterName":"example","schemaClass":"example","additional":false,"required":false,"enabled":true,"position":50}]

GET
Retrieve address field by id

id
integer Required
Id value of the AddressField object
default Success <XLite\Model\AddressField>
Sample response
{"id":33,"serviceName":"example","viewGetterName":"example","schemaClass":"example","additional":false,"required":false,"enabled":true,"position":50}
id
integer
Unique id
serviceName
string
Service 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
string
Getter 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
string
Schema 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
boolean
Flag if the field is an additional one (This field could be removed)
required
boolean
Flag if the field is a required one
enabled
boolean
Flag if the field is an enabled one
position
integer
Position

PUT
Update address field by id

id
integer Required
Id value of the AddressField object
<XLite\Model\AddressField>
id
integer
Unique id
serviceName
string
Service 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
string
Getter 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
string
Schema 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
boolean
Flag if the field is an additional one (This field could be removed)
required
boolean
Flag if the field is a required one
enabled
boolean
Flag if the field is an enabled one
position
integer
Position
default Success <XLite\Model\AddressField>
Sample response
{"id":33,"serviceName":"example","viewGetterName":"example","schemaClass":"example","additional":false,"required":false,"enabled":true,"position":50}
id
integer
Unique id
serviceName
string
Service 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
string
Getter 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
string
Schema 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
boolean
Flag if the field is an additional one (This field could be removed)
required
boolean
Flag if the field is a required one
enabled
boolean
Flag if the field is an enabled one
position
integer
Position

DELETE
Delete address field by id

id
integer Required
Id value of the AddressField object
default Success <XLite\Model\AddressField>
Sample response
{"id":33,"serviceName":"example","viewGetterName":"example","schemaClass":"example","additional":false,"required":false,"enabled":true,"position":50}
id
integer
Unique id
serviceName
string
Service 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
string
Getter 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
string
Schema 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
boolean
Flag if the field is an additional one (This field could be removed)
required
boolean
Flag if the field is a required one
enabled
boolean
Flag if the field is an enabled one
position
integer
Position

POST
Add new address field

<XLite\Model\AddressField>
id
integer
Unique id
serviceName
string
Service 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
string
Getter 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
string
Schema 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
boolean
Flag if the field is an additional one (This field could be removed)
required
boolean
Flag if the field is a required one
enabled
boolean
Flag if the field is an enabled one
position
integer
Position
default Success <XLite\Model\AddressField>
Sample response
{"id":33,"serviceName":"example","viewGetterName":"example","schemaClass":"example","additional":false,"required":false,"enabled":true,"position":50}
id
integer
Unique id
serviceName
string
Service 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
string
Getter 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
string
Schema 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
boolean
Flag if the field is an additional one (This field could be removed)
required
boolean
Flag if the field is a required one
enabled
boolean
Flag if the field is an enabled one
position
integer
Position