Skip to main content
GET
/
api
/
v1
/
customer
/
addresses
/
zip-codes
/
{zipCode}
Lookup Zip Code
curl --request GET \
  --url https://api.example.com/api/v1/customer/addresses/zip-codes/{zipCode}
{
  "zipCode": "04102000",
  "city": "Sao Paulo",
  "state": "SP",
  "country": "BR",
  "street": "Rua das Palmeiras",
  "neighborhood": "Vila Mariana"
}

Path Parameters

​
zipCode
string
required

Zip code.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

Address data resolved from zip code.

​
zipCode
string
required

Zip code.

Example:

"04102000"

​
city
string
required

City.

Example:

"Sao Paulo"

​
state
string
required

State.

Example:

"SP"

​
country
string
required

Country.

Example:

"BR"

​
street
string

Street.

Example:

"Rua das Palmeiras"

​
neighborhood
string

Neighborhood.

Example:

"Vila Mariana"