VTvtex
Fulfillment

Get address by postal code

Retrieves address information for a given postal code and country.

This request can be used to implement auto complete functionality when a customer needs to fill in an address.

Permissions

This endpoint does not require permissions.

get/api/checkout/pub/postal-code/{countryCode}/{postalCode}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/checkout/pub/postal-code/{countryCode}/{postalCode}
  • Auth
    none required

Path parameters

countryCodestring required
Example:BRA

Three letter country code refering to the postalCode field.

postalCodestring required
Example:1234000

Postal code.

Query parameters

individualShippingEstimatesboolean
Example:true

Shows the product's estimated shipping date in the shippingEstimate field from the orderForm.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

postalCodestring

Postal code.

citystring

City.

statestring

State.

countrystring

Country.

streetstring

Street.

numberstring

Number.

neighborhoodstring

Neighborhood.

complementstring nullable

Complement to the shipping address, in case it applies.

referencestring

Reference.

geoCoordinatesinteger[]

Geo coordinates.

Changes

No recorded changes to this operation across all 57 revisions of this API.