Get sellers by region or address

Retrieves a list of sellers that cater to a specific region or address, according to your setup of our regionalization feature. Learn more about Region v2.

To access the list of sellers, you must choose one of the following methods:

1. Send the identification of the list of sellers (regionId) as a path parameter through the URL. Or;

2. Send the country (3-digit ISO code) and at least one of the two values (postal Code or geo Coordinates) as query parameters through the URL. For this method, it is also allowed to send both values (postalCode or geoCoordinates) in the same request.

The regionId and country parameters are indicated as required in this documentation. However, only one of them should be sent in the request according to one of the methods mentioned above.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

[
  -47.924747467041016,
  -15.832582473754883
]