Magento Commerce, 2.2.x

Magento 2.2.x Notice: As outlined by the Magento Software Lifecycle Policy, Magento 2.2.x has reached the End-of-Support and will no longer receive quality fixes or documentation updates. To maintain your site's performance, security, and PCIPayment Card Industry: Refers to debit and credit cards and their associated businesses. compliance, upgrade to the latest version of Magento.

The online Magento 2.2.x User Guide is scheduled for removal, but will remain available in PDF for Open Source, Commerce, and Commerce for B2B.

Customer Address Attributes

The Customer Address Attribute determines the properties of street addresses that are entered into the address book from the customer’s account, or during checkout.

Custom address attributes can be set up if you need to provide additional information such as an optional email address, Skype account, alternate phone number, building, or county. The custom attributeA characteristic or property of a product; anything that describes a product. Examples of product attributes include color, size, weight, and price. can then be incorporated into the address template that is used to produce sales documents. The process to create a custom address attribute is almost the same as creating a customer attribute.

Customer address attributes are used in the following forms:

Customer Address Attributes
  • Field Descriptions



    Attribute Properties

    Default Label

    The default label that identifies the attribute in the AdminThe password-protected back office of your store where orders, catalog, content, and configurations are managed. and storefront.

    Attribute Code

    A unique code that identifies the attribute within the system. The code can be up to 21 characters in length, and cannot include spaces or special characters. The underscore symbol can be used instead of a space.

    Input Type

    Determines the input control that is used for data entry. Options:

    Text Field

    A single-line text field.

    Text Area

    A multi-line text area.

    Multiple Line

    Creates multiple text lines for the attribute, similar to a multi-line street address. The number of separate data entry lines can be from 2 to 20. Additional property:

    Default Value

    Specifies the initial value of the field.


    Displays a date field with a pop-up calendar.

    Additional properties:

    Default Value

    Sets a default date.

    Minimal Value

    Determines the earliest date that can be entered.

    Maximum Value

    Determines the latest date that can be entered.

    Related properties:

    Input Validation


    Input/Output Filter

    Normalize Date


    A drop-down list that accepts only one value to be selected.

    Multiple Select

    A drop-down list that accepts multiple values to be selected. To select more than one value, hold down the Ctrl key, and click each option.


    A field that offers only a choice of “Yes” or “No” values.

    File (attachment)

    A field that allows a file to be uploaded, and associated with the customer attribute as an attachment.

    Image File

    A field that allows an image to be uploaded to the gallery, and associated with the customer attribute.

    Values Required

    Determines if a value must be entered into the field. Options: Yes/No

    Default Value

    Specifies the initial value of the attribute.

    Input Validation

    The selection of options is determined by the input type. Options:


    The field has no input validation during data entry.


    Accepts any combination of numbers (0-9) and alphabetic characters (a-z, A-Z) during data entry.

    Alphanumeric with Space

    Allows spaces in the street address to comply with maximum length requirements of carrier.

    During checkout, the customer can enter any combination of numbers (0-9), alphabetic characters (a-z, A-Z), and spaces in the street address of the recipient and sender. Any extra spaces are trimmed when the address is saved.

    Numeric Only

    Accepts only numbers (0-9) during data entry.

    Alpha Only

    Accepts only alphabetic characters (a-z, A-Z) during data entry.


    Accepts only a URL during data entry.


    Accepts only an email address during data entry.

    Length Only

    Validates the input based on the length of the data entered into the field.

    Input/Output Filter

    Applies a preprocessing filter to values entered in a text field, text area, or multiple line input type before the record is saved. Options:


    Does not apply a filter to text entered into the field.

    Strip HTML Tags

    Removes HTML tags from the text. This filter can help clean up data that is pasted into a field from another source that includes HTML tags.

    Escape  HTML Entities

    Converts special characters found in the text to a valid HTML escape sequence, such as &. You can use this filter to clean up special characters that might be pasted into database fields from a word processor.

    Escape sequences are enclosed between an ampersand and a semi-colon, and are frequently used for typographer’s smart quotes, copyright and trademark symbols. Escape sequences are also used to identify characters such as the less than (<) and greater than (>) symbols, and the ampersand character which are also used in the code.

    Add to Column Options

    Specifies if the attribute is included as a column in the Customers grid. Options: Yes/No

    Use in Filter Options

    Specifies if the attribute can be used as a filter for search operations from the grid. Options: Yes/No

    Use in Search Options

    Specifies if the attribute value can be used as a keyword in search operations. Options: Yes/No

    Use in Customer Segment

    Determines if the attribute is included in customer segment conditions. Options: Yes/No

    Storefront Properties

    Show on Storefront

    Determines if the attribute appears as a field in the customer information in the storefront. Options: Yes/No

    Sort Order

    Specifies the sort order of this attribute in relation to other customer attributes. The sort order determines the sequence that fields receive focus during data entry when using keyboard navigation.

    Forms to Use in

    Determines the pages with data entry forms where the attribute appears. Hold down the Ctrl key to choose multiple forms. Options:

    Customer Address Registration

    Customer Account Address