To assist the customer in the process of filling in data at Checkout and also to select the sellers able to deliver the product in a certain area, it is possible to register postal codes and assign them to addresses in the VTEX database. For more information about deliveries, visit Inventory & shipping - Overview.

This guide describes how to obtain the registered address information for a specific postal code and country.

To get the registered address information for a postal code, you need to use the Get address by postal code endpoint. The country and postal code information must be sent through the URL request, as shown by the example below:

https://{accountname}.{environment.com.br}/api/checkout/pub/postal-code/BRA/22250040

After sending the request, the endpoint will return the response body containing the address information registered, as shown in the example below:

The following errors may appear as a message in the response body.

Despite the code 200 (which indicates the success of the request), if there is no registered address in the VTEX database associated with the entered postal code or country, the response body will not contain any address information.

• Message error example: "The requested URL was not found on the server": check that the URL data is correct.

• Message error example (code ORD026): "A communication error with Postal Code Service has occurred": this message will appear when less than three country code digits are entered in the URL request.