Address Object
The address object is used in various APIs to represent an address. The structure is standardized across all endpoints.
Structure
| Field | Type | Required | Description |
|---|---|---|---|
street | string | Yes | Street address. |
number | string | Yes | Address number. |
complement | string | No | Complement. |
neighborhood | string | Yes | Neighborhood. |
city | string | Yes | City. |
state | string | Yes | State (2-character abbreviation). |
postal_code | string | Yes | Postal code (format XXXXXXXX, without hyphen). |
Example
{
"street": "Rua Example",
"number": "123",
"complement": "Sala 1",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postal_code": "01001000"
}