Pickup points are locations where customers pick up their orders. A store provides pickup points so that its customers have the option of choosing to receive their order at their address (delivery) or to pick it up at a specified location (pickup). For more information, access pickup points.

This guide will describe how to retrieve information about collection points close to a certain location determined by geographic coordinates or postal and country codes.

To list all pickup points near a specific location, you need to use the List pickup points by location endpoint. There are two methods to retrieve pickup points using query parameters in the URL request.

Base URL: https://{accountName}.{environment}.com.br/api/checkout/pub/pickup-points

Use the geographic coordinates (first longitude, then latitude) of the location where you want to check for nearby pickup points. See a URL request example below:

https://{accountName}.{environment}.com.br/api/checkout/pub/pickup-points?geoCoordinates=-43.1974334;-22.9573465

Use the postal and country codes of the location where you want to check for nearby pickup points. See a URL request example below:

https://{accountName}.{environment}.com.br/api/checkout/pub/pickup-points?postalCode=22250040&countryCode=BRA

The search for pickup points must be done using only one of the two methods in the URL (geographical coordinates or postal and country codes). If you try to use both query parameters, the request will not return the list of collection points.

After choosing one of the two described methods and sending the URL request, the terminal will return the body of the response containing the information of the registered pickup points closest to the informed location, as shown in the example below:

The pickup points returned are not necessarily all active. Make sure to validate the current availability information with the responsible for the pick up points on your account.

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

• Message error example (code ORD001): "Input string was not in the correct format": this message will appear when the geoCoordinates value field is not set correctly in the URL request.

• Message error example (code CHK0264): "Pickup not found": this message will appear when there are no pickup points near the location informed in this request.

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