VTEX Commerce APIs

REST discovered

Details

URL: https://{accountName}.{environment}.com.br
Docs: https://developers.vtex.com/docs/api-reference

Authentication

VTEX API key pair (appKey + appToken) X-VTEX-API-AppKey: <credential> + VTEX API key pair (appKey + appToken) X-VTEX-API-AppToken: <credential> discovered

VTEX API key pair (appKey + appToken) compound Get key ↗

In the VTEX Admin, create an application key as described in Generating and managing application keys. This gives you an appKey and its paired appToken. Grant the key the needed License Manager roles/resources as described in Managing app key permissions.

VTEX user token jwt discovered Get key ↗

VtexIdclientAutCookie: <credential>

Log in to a VTEX store as a shopper or admin. VTEX ID issues a JWT and sets it as the VtexIdclientAutCookie cookie, which can then be sent as the VtexIdclientAutCookie header as documented in API authentication using user tokens.