# systemcode/customer-address-autocomplete-brazil

> Brazilian postcode mask and address autocomplete for Magento customer address forms.

`composer require systemcode/customer-address-autocomplete-brazil`

Canonical URL: https://packagento.com/systemcode/customer-address-autocomplete-brazil

## At a glance

- **Vendor**: systemcode (https://packagento.com/systemcode.md)
- **Latest version**: 1.0.0 — released 2026-06-11
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/systemcode/customer-address-autocomplete-brazil and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require systemcode/customer-address-autocomplete-brazil:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Brazilian postcode mask and address autocomplete for Magento customer address forms.

## README

### About Module

Adds Brazilian CEP masking and address autocomplete on checkout and customer address forms. Looks up street, neighborhood, city, and state via zip code API, with options to reorder fields, disable address fields until lookup completes, lock autofilled data (including street prefix), and allow manual entry on lookup failure.

#### Configuration

**Stores > Configuration > System Code > Address Autocomplete (Brazil)**

#### Screenshots

##### Admin Configuration
![Admin Configuration](.github/images/configuration.png)

##### Frontend
![Checkout](.github/images/frontend.png)

#### Requirements

- `systemcode/base`
- `systemcode/customer`
- `magento/module-customer`
- `magento/module-checkout`
- `magento/module-directory`

#### How to install

##### ✓ Install by Composer (recommended)
```
composer require systemcode/base systemcode/customer systemcode/customer-address-autocomplete-brazil
php bin/magento module:enable SystemCode_CustomerAddressAutocompleteBrazil
php bin/magento setup:upgrade
```

##### ✓ Install Manually
- Copy module to folder `app/code/SystemCode/CustomerAddressAutocompleteBrazil` and run commands:
```
php bin/magento module:enable SystemCode_CustomerAddressAutocompleteBrazil
php bin/magento setup:di:compile
php bin/magento setup:upgrade
```

#### Suggested installation bundles

These modules are not required by Address Autocomplete (Brazil), but work well together for a complete Brazilian address experience.

##### Address essentials
Custom street labels, street prefix, and CEP autocomplete.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-street-lines \
  systemcode/customer-street-prefix \
  systemcode/customer-address-autocomplete-brazil
```

##### Address autocomplete + registration
Collect the customer address during account creation.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-address-registration
```

##### Address + Brazilian identity
Combine address autocomplete with CPF/CNPJ customer identity.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-identity-brazil
```

##### Full Brazilian storefront stack
Address, identity, registration, street labels, and street prefix.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-address-registration \
  systemcode/customer-street-lines \
  systemcode/customer-street-prefix \
  systemcode/customer-identity-brazil
```

##### Full stack with Enhanced identity
Dedicated CPF, CNPJ, Social Name, and Trade Name fields.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-address-registration \
  systemcode/customer-street-lines \
  systemcode/customer-street-prefix \
  systemcode/customer-identity-brazil \
  systemcode/customer-identity-brazil-enhanced
```

#### License
OSL-3.0

#### Authors
* [Eduardo Diogo Dias](https://github.com/eduardoddias)


---


### Sobre o Módulo

Adiciona máscara de CEP brasileiro e autocomplete de endereço no checkout e nos formulários de endereço do cliente. Consulta logradouro, bairro, cidade e estado pela API de CEP, com opções para reordenar campos, desabilitar endereço até a consulta, bloquear campos preenchidos automaticamente (incluindo prefixo de logradouro) e permitir preenchimento manual em caso de falha.

#### Configuração

**Lojas > Configuração > System Code > Address Autocomplete (Brazil)**

#### Screenshots

##### Configuração no Admin
![Configuração no Admin](.github/images/configuration.png)

##### Frontend
![Checkout](.github/images/frontend.png)

#### Requisitos

- `systemcode/base`
- `systemcode/customer`
- `magento/module-customer`
- `magento/module-checkout`
- `magento/module-directory`

#### Como Instalar

##### ✓ Instalação via Composer (recomendado)
```
composer require systemcode/base systemcode/customer systemcode/customer-address-autocomplete-brazil
php bin/magento module:enable SystemCode_CustomerAddressAutocompleteBrazil
php bin/magento setup:upgrade
```

##### ✓ Instalação Manual
- Copie o módulo para `app/code/SystemCode/CustomerAddressAutocompleteBrazil` e execute:
```
php bin/magento module:enable SystemCode_CustomerAddressAutocompleteBrazil
php bin/magento setup:di:compile
php bin/magento setup:upgrade
```

#### Combinações de instalação sugeridas

Estes módulos não são obrigatórios para o Address Autocomplete (Brazil), mas combinam bem para uma experiência completa de endereço brasileiro.

##### Essenciais de endereço
Rótulos de rua, prefixo de logradouro e autocomplete de CEP.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-street-lines \
  systemcode/customer-street-prefix \
  systemcode/customer-address-autocomplete-brazil
```

##### Autocomplete + cadastro
Coleta o endereço do cliente já no cadastro.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-address-registration
```

##### Endereço + identidade brasileira
Autocomplete de endereço com identidade CPF/CNPJ.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-identity-brazil
```

##### Stack completo brasileiro
Endereço, identidade, cadastro, rótulos de rua e prefixo de logradouro.
```
composer require systemcode/base systemcode/customer \
  systemcode/customer-address-autocomplete-brazil \
  systemcode/customer-address-registration \
  systemcode/customer-street-lines \
  systemcode/customer-street-prefix \
  systemcode/customer-identity-brazil
```

_(README truncated for .md surface. Full README on https://packagento.com/systemcode/customer-address-autocomplete-brazil.)_

## Recent Versions

| Version | Released |
|---|---|
| 1.0.0 | 2026-06-11 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/module-checkout | * |
| magento/module-customer | * |
| magento/module-directory | * |
| systemcode/base | ^2.0 |
| systemcode/customer | ^1.0 |

## Quality

Latest release (1.0.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 4 | valid; 4 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["systemcode/customer-address-autocomplete-brazil"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

systemcode is a Magento 2 vendor on Packagento. See https://packagento.com/systemcode.md for their full catalogue.