# Component: Edit Address

**Purpose**: Allows customers to update their delivery address and/or billing address.

<figure><img src="/files/EL4AJnBGEwh5QxPKpUSt" alt=""><figcaption></figcaption></figure>

## Props

| Prop Name                | Label                               | Type    | Default Value                          | Description                                              |
| ------------------------ | ----------------------------------- | ------- | -------------------------------------- | -------------------------------------------------------- |
| hideBillingAddress       | Hide Billing Address                | boolean | false                                  | If true the billing address is hidden                    |
| hideDeliveryAddress      | Hide Delivery Address               | boolean | false                                  | If true the delivery address is hidden                   |
| editAddressButtonText    | Edit address button text            | string  | Edit address                           | Text for edit address button                             |
| firstNameLabel           | First name label                    | string  | First name                             | Text of first name label                                 |
| lastNameLabel            | Last name label                     | string  | Last name                              | Text of last name label                                  |
| address1Label            | Delivery address line 1 label       | string  | Address line 1                         | Text of address 1 label                                  |
| address2Label            | Delivery address line 1 label       | string  | Address line 2                         | Text of address 2 label                                  |
| deliveryCompanyLabel     | Delivery Company label              | string  | Company                                | Text of delivery company label                           |
| cityLabel                | Delivery city label                 | string  | City                                   | Text of city label                                       |
| stateLabel               | Delivery county/state label         | string  | {{state\_name\_type}}                  | Text of state label                                      |
| postalCodeLabel          | Delivery postal code/ZIP code label | string  | {{zip\_name\_type}}                    | Text of post code label                                  |
| countryLabel             | Delivery country label              | string  | Country                                | Text of country label                                    |
| invalidFirstNameMessage  | Invalid first name message          | string  | First name is required                 | Text for invalid first name error message                |
| invalidLastNameMessage   | Invalid last name message           | string  | Last name is required                  | Text for invalid last name error message                 |
| invalidAddressMessage    | Invalid address message             | string  | Address is required                    | Text for invalid address error message                   |
| invalidCityMessage       | Invalid city message                | string  | City is required                       | Text for invalid city error message                      |
| invalidStateMessage      | Invalid state/county message        | string  | {{state\_name\_type}} is required      | Text for invalid state error message                     |
| invalidPostalCodeMessage | Invalid zip/postal code message     | string  | {{zip\_name\_type}} is required        | Text for invalid postcode error message                  |
| invalidCountryMessage    | Invalid country message             | string  | Country is required                    | Text for invalid country error message                   |
| addressChangeSuccessText | Address change success text         | string  | Your address details have been updated | Text for address change success text                     |
| prefillMapping           | Label Mapping                       | list    |                                        |                                                          |
|                          |                                     |         |                                        |                                                          |
| showCompanyField         | how delivery company field?         | boolean | false                                  | If true the company field will show                      |
| showOptionalFields       | Highlight optional fields?          | boolean | false                                  | If true the optional fields will be visually highlighted |

## Integration:

* **Webhooks:** Any changes will trigger an event (order.address\_change) and will be provided in the Address Change webhook - learn more [here](https://docs.limio.com/developers/webhooks/using-webhooks).
* **OOTB integration:** Any updates to the address are applied to the following information:
  * Limio: Limio Customer's billing or delivery address will be updated.
  * Zuora: Limio will update the billToContact and soldToContact objects for billing and delivery address respectively.
  * Salesforce via Zuora Z360: Refer to Zuora [documentation](https://knowledgecenter.zuora.com/Zuora_CPQ/E_Zuora_360_plus_and_360/Z_Zuora_360_Introduction/Sync_Field_Mapping_of_Account_and_Related_Objects).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.limio.com/components/component-library/legacy-configuration-components/component-edit-address.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
