v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-291317322.2 KB
Stores

Get stores

Retrieves the stores of the account and their respective hosts.

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:

ProductCategoryResource
License ManagerServices access controlGet account by identifier

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Finance - Full accessGet account by identifier

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.

To learn more about machine authentication at VTEX, see Authentication overview.

get/api/vlm/account/stores

Response

Success

idnumber

ID of the store.

namestring

Name of the store.

hostsstring[]

Array of hosts corresponding to the store.