Brazilian Checkout Fields for OpenCart 2.3, 3.x and 4.x — CPF, CNPJ, address from the CEP

Brazilian Checkout Fields makes the OpenCart checkout fit Brazil: CPF or CNPJ, house number, bairro and the address from the CEP. All data goes into OpenCart’s own custom fields, so orders, customers and other modules see it.

What the buyer sees

The buyer picks individual or company, sees only the fields that apply and types the number with a mask. A wrong CPF or CNPJ stops the form with a message under the field. After the CEP the street, city, bairro and state fill in by themselves. If the address service does not answer, the buyer fills everything by hand and the order is not blocked. A buyer from abroad does not see these fields.

What the admin gets

In the settings you choose who is asked for a document and which fields show. The order page shows the document, and a separate tab finds orders by CPF or CNPJ. Pro adds a refusal by CNPJ status, one document per account, CSV and a check of older orders.

How it works, step by step

1. Install the module: the fields are created for all customer groups.
2. Choose who is asked for a document and which fields you need.
3. The buyer enters the CEP and the address fills in.
4. A wrong CPF or CNPJ is stopped on the server.
5. The order gets the document, number and bairro.

Under the hood

• Nothing is patched: only OpenCart’s own custom fields and events.
• ViaCEP and BrasilAPI are free, with no promise of uptime. There is a cache and a limit per IP.
• IE is checked by format only, state check digits are not computed.
• A payment module’s own button outside the confirm block can bypass the panel for a returning customer: in Pro the order check shows it.
• On removal the fields are hidden and the data stays.

How to install

1. Extensions → Installer: upload the archive for your version and keep the file name.
2. OpenCart 2.3: the Installer copies files only with FTP enabled. Without FTP copy the contents of upload/ to the shop root by hand.
3. OpenCart 2.3 and 3.x: Extensions → Modifications → Refresh.
4. Extensions → Modules → Brazilian Checkout Fields → install button → Edit.
5. Try the fields at checkout with a Brazilian address.
6. Change the list of fields in the settings if you need to.
7. For Pro: paste the key or start the 7-day trial.