VTEX API Connection
Prepare VTEX account name, Application Key, and Application Token for a Next-Cart migration service when VTEX API setup is shown.
VTEX API Connection
Section titled “VTEX API Connection”A valid VTEX API connection gives Next-Cart the authorized platform access required by the selected migration path.
Next-Cart may ask for your VTEX Store URL, account name, Application Key, and Application Token. Prepare these values from the correct VTEX account.
When to use this guide
Section titled “When to use this guide”Use this guide when:
- VTEX is the Source Platform or Target Platform in your selected migration path;
- Next-Cart shows VTEX API setup;
- Next-Cart asks for VTEX connection values.
Prerequisites
Section titled “Prerequisites”Before you begin, confirm that:
| Requirement | Why it matters |
|---|---|
| Correct VTEX account access | The credentials must be created in the store or account shown in the migration path. |
| Permission to manage API or integration access | The account must be allowed to create, view, or authorize connection values. |
| Scope decisions | You need to know which data types Next-Cart must access. |
| Secure storage | API credentials and tokens must be copied only into approved secure locations. |
| Next-Cart connection screen open | Enter only the values requested by the interface. |
Required values
Section titled “Required values”| Required value | Where to prepare it | Notes |
|---|---|---|
| Store URL | VTEX admin or store domain | Commonly based on the account domain requested by Next-Cart. |
| Account Name | VTEX account domain | The account name portion used by the VTEX environment. |
| Application Key | VTEX application key management | Create a key for the migration service or use the key shown for the supported setup. |
| Application Token | Generated with the Application Key | Copy immediately and store securely. |
Prepare the API connection values
Section titled “Prepare the API connection values”- Sign in to the correct VTEX admin environment.
- Open the area used to manage application keys or API keys.
- Generate a new application key for the migration service, or use the supported key setup shown by VTEX and Next-Cart.
- Assign roles or resources that allow access to the data areas in the migration scope.
- Generate or reveal the matching Application Token.
- Copy the Application Key, Application Token, Account Name, and Store URL exactly as shown.
Enter the values in Next-Cart
Section titled “Enter the values in Next-Cart”In the Next-Cart connection setup screen, enter only the values requested by the interface.
| Next-Cart field | Platform value |
|---|---|
| Store URL | Store URL prepared from VTEX. |
| Account Name | Account Name prepared from VTEX. |
| Application Key | Application Key prepared from VTEX. |
| Application Token | Application Token prepared from VTEX. |
Expected result
Section titled “Expected result”The VTEX API connection values are ready to test in Next-Cart.
Verify the connection
Section titled “Verify the connection”| Check | Pass condition |
|---|---|
| Store match | The prepared values belong to the VTEX store shown in Next-Cart. |
| Permission coverage | The credentials cover the selected migration data. |
| Value completeness | Each value is copied without truncation, extra spaces, or missing characters. |
| Connection test | Next-Cart can authenticate and read supported VTEX data. |
If the connection fails
Section titled “If the connection fails”| Issue | What to check |
|---|---|
| Authentication error | Confirm the Application Key and Application Token are a matching pair. |
| Permission error | Review the roles and resources assigned to the application key. |
| Wrong account | Confirm the account name and domain match the store shown in Next-Cart. |
| Token exposed | Rotate the token and replace the value in Next-Cart before testing again. |
Security cleanup
Section titled “Security cleanup”After migration work is complete and verified:
- remove or revoke temporary API credentials where the platform provides that option;
- reduce access if a broader permission set was used only for migration work;
- remove copied credentials from insecure notes, tickets, chats, or shared files;
- review the store admin account or API user used for API setup.
Next step
Section titled “Next step”| Goal | Go to |
|---|---|
| Test the connection | Verify Platform Connections |
| Fix an authentication or permission issue | Troubleshoot Connection Setup |
| Continue after the connection passes | Configure Your Migration |