=== CheckoutBR – CPF, CNPJ and Brazilian Address Fields for WooCommerce ===
Contributors: wooglobalapps
Tags: cpf, cnpj, brazil, checkout fields, woocommerce
Requires at least: 6.2
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

CPF, CNPJ (including the new alphanumeric CNPJ), number and bairro fields that work in the Checkout block AND the classic checkout.

== Description ==

**Works in the new Checkout block and in the classic checkout. Supports the new alphanumeric CNPJ.**

Brazilian stores need CPF or CNPJ, the address number and the neighborhood (bairro) for invoices (NF-e), payment gateways and shipping labels. Most field plugins only work with the old shortcode checkout, so the fields simply disappear when the store switches to the **Checkout block** – and most still reject the alphanumeric CNPJ issued since July 2026.

**CheckoutBR** adds the Brazilian fields to **both** checkouts. In the Checkout block it uses the official WooCommerce *Additional Checkout Fields* API, so the fields are native, saved with the order and validated on the server.

**Features**

* **Checkout block + classic checkout** with the same fields, settings and validation.
* **Alphanumeric CNPJ** (e.g. 12.ABC.345/01DE-35) and the classic numeric CNPJ, validated with the official check-digit rule.
* **Person type**: Individual (Pessoa Física) or Company (Pessoa Jurídica). You can also accept only individuals or only companies.
* **CPF** for individuals and **CNPJ** plus **company name (razão social)** for companies. The right document is required depending on the person type – enforced on the server, not only in the browser.
* **Real CPF validation** with check digits. Sequences such as 111.111.111-11 are rejected.
* **Address number** and **neighborhood (bairro)** for billing and shipping addresses.
* Optional **birth date** and **mobile phone** fields.
* Choose which fields are enabled, required or optional.
* **Input masks** in the classic checkout (CPF, CNPJ with letters, CEP, phone, date). Values are stored without punctuation, CNPJ in uppercase.
* Optional **CEP auto-fill** with ViaCEP (off by default, see "External services").
* **Compatibility mode** (on by default): uses the same order and customer fields as the Brazilian Market on WooCommerce plugin, so stores can switch with zero data loss.
* The fields appear only when the country is Brazil, so international customers are not affected.
* Shows the data on the **order edit screen**, **order emails**, the **thank-you page**, **My Account** (addresses and account details) and adds the number and neighborhood to the formatted address.
* Compatible with **HPOS** (High-Performance Order Storage) and the **Cart/Checkout blocks**.
* Lightweight: one small vanilla JavaScript file, no jQuery plugins, no tracking.
* Translation ready.

**Where is the data saved?**

Every order gets the same meta keys, whatever checkout was used. With compatibility mode on (default): `_billing_persontype` (1 = individual, 2 = company), `_billing_cpf`, `_billing_cnpj`, `_billing_company`, `_billing_birthdate`, `_billing_cellphone`, `_billing_number`, `_billing_neighborhood`, `_shipping_number` and `_shipping_neighborhood` (customer meta: `billing_cpf`, `billing_number`…). With compatibility mode off, the keys are prefixed: `_billing_checkoutbr_cpf`, `_billing_checkoutbr_number`… Block orders also keep the native Additional Checkout Fields data (`_wc_other/checkoutbr/…`, `_wc_billing/checkoutbr/…`).

== External services ==

This plugin can connect to **ViaCEP** (https://viacep.com.br), a free public web service that returns a Brazilian address for a postal code (CEP). It is used only to auto-fill the street, neighborhood, city and state at checkout.

* The feature is **disabled by default**. It runs only after the store owner enables "CEP auto-fill (ViaCEP)" in **WooCommerce → CheckoutBR**.
* When enabled, the customer's browser sends **only the CEP** typed in the postcode field (8 digits) to `https://viacep.com.br/ws/{CEP}/json/` when the postcode field is changed and the country is Brazil. No name, document, email or other personal data is sent, and nothing is sent from your server.
* ViaCEP website and terms of use: https://viacep.com.br/ – the service is provided "as is" by its maintainers; see the website for its usage terms and limits.

No other external service is used.

== Installation ==

1. Install and activate WooCommerce.
2. Upload the `checkoutbr` folder to `/wp-content/plugins/` or install it from **Plugins → Add New**.
3. Activate CheckoutBR.
4. Go to **WooCommerce → CheckoutBR** to choose which fields are enabled or required.

== Frequently Asked Questions ==

= Does it work with the new Checkout block? =

Yes. The fields are registered with the WooCommerce Additional Checkout Fields API (WooCommerce 8.9 or newer). Person type, CPF, CNPJ, company name, birth date and mobile phone appear in the Contact information step; number and neighborhood appear in the address forms.

= Does it work with the classic [woocommerce_checkout] shortcode? =

Yes. The same fields, validation and settings are used in the classic checkout, with input masks.

= Is the CPF/CNPJ really validated? =

Yes. The check digits are calculated on the server for both checkouts, and numbers made of a single repeated digit are rejected. When "Individual" is selected the CPF is required; when "Company" is selected the CNPJ (and, if enabled, the company name) is required.

= In the Checkout block, CPF and CNPJ are both visible. Why? =

Showing only the field for the selected person type needs conditional fields, available in recent WooCommerce versions. CheckoutBR uses them automatically when available. On older versions both fields are shown, but only the one for the selected person type is required.

= What happens with customers outside Brazil? =

The fields are hidden and not required when the billing (or shipping) country is not Brazil.

= Does it send data to other servers? =

Only if you enable the optional CEP auto-fill: the customer's browser sends the CEP to ViaCEP. See the "External services" section.

= Can payment or invoice plugins read the values? =

Yes. Use the order meta keys listed in the description, for example `$order->get_meta( '_billing_cpf' )` (compatibility mode). CPF is stored as digits only; CNPJ as 14 uppercase letters/digits.

= Does it accept the new alphanumeric CNPJ? =

Yes. Since July 2026 new CNPJs may contain letters in the first 12 characters (for example 12.ABC.345/01DE-35). CheckoutBR validates both the alphanumeric and the classic numeric format with the official check-digit rule (each character is worth its ASCII code minus 48). Lowercase input is accepted and saved in uppercase.

= I use Brazilian Market on WooCommerce (WooCommerce Extra Checkout Fields for Brazil). Can I switch? =

Yes – you can migrate in 15 minutes, with zero data loss:

1. Install and activate CheckoutBR. Keep **Compatibility mode** on (default).
2. In **WooCommerce → CheckoutBR**, choose the fields you need and click **Check existing Brazilian data**: it counts the orders and customers that already use the compatible fields.
3. Deactivate Brazilian Market on WooCommerce.
4. Place a test order with the classic checkout or the Checkout block.

CheckoutBR reads and writes the same order and customer fields (`_billing_persontype`, `_billing_cpf`, `_billing_cnpj`, `_billing_number`, `_billing_neighborhood`, `_billing_cellphone`, `_billing_birthdate`, `_shipping_number`, `_shipping_neighborhood`…), so old orders keep showing CPF/CNPJ, returning customers are pre-filled (also in the Checkout block) and integrations that read those fields keep working. RG, IE and gender saved by the old plugin are still shown on old orders.

= Are the fields removed when I uninstall? =

The plugin settings are deleted. The data saved on orders and customers is kept, because it is part of your order history.

== Screenshots ==

1. CPF, CNPJ and person type in the Checkout block.
2. Address number and neighborhood in the classic checkout.
3. Settings page.

== Changelog ==

= 1.0.0 =
* First release.
