CommerceHQ API Connection
Prepare CommerceHQ private app API details for the Next-Cart migration service.
CommerceHQ API Connection
Section titled “CommerceHQ API Connection”A valid CommerceHQ API connection gives Next-Cart the authorized platform access required by the selected migration path.
The goal is to create or locate private app credentials and prepare the Store URL, API Key, and API Password for connection testing.
When to use this guide
Section titled “When to use this guide”Use this guide when:
- the selected platform is CommerceHQ;
- Next-Cart asks for CommerceHQ API credentials;
- you can access the CommerceHQ admin;
- you can create or manage private apps.
Prerequisites
Section titled “Prerequisites”| Requirement | Why it matters |
|---|---|
| Admin access | You need access to the CommerceHQ admin area. |
| Permission to manage apps | API credentials are created or viewed through private app settings. |
| Migration scope | App access should include the resources selected for migration. |
| Secure credential handling | API passwords must be protected and entered only through approved channels. |
Required values
Section titled “Required values”| Value | Where to find it | Notes |
|---|---|---|
| Store URL | Your CommerceHQ store URL. | Use the store associated with the purchased migration path. |
| API Key | Private app settings. | Copy it exactly. |
| API Password | Private app settings. | Treat it as sensitive. |
Create or locate private app credentials
Section titled “Create or locate private app credentials”- Sign in to the CommerceHQ admin.
- Open the dashboard.
- Go to Apps Store.
- Select Add a Private App.
- Enter a recognizable private app name such as Next-Cart Migration.
- Grant access to the resources included in the migration scope, such as Products, Orders, and Customers.
- Save the private app.
- Open the private app settings from installed apps.
- Copy the API Key and API Password.
Enter the values in Next-Cart
Section titled “Enter the values in Next-Cart”In Next-Cart, enter the CommerceHQ Store URL, API Key, and API Password.
Use credentials from the store included in the purchased migration path.
Expected result
Section titled “Expected result”Next-Cart has the CommerceHQ API details required for connection testing.
Verify the connection
Section titled “Verify the connection”| Check | Pass condition |
|---|---|
| Private app | The app exists and is active. |
| Store URL | The URL belongs to the intended CommerceHQ store. |
| API Key | The key is copied exactly from private app settings. |
| API Password | The password is copied exactly and stored securely. |
| Resource access | The app has access to the selected migration resources. |
| Connection test | Next-Cart verifies access without authentication or permission errors. |
If the connection fails
Section titled “If the connection fails”| Issue | What to check |
|---|---|
| API Key rejected | Re-copy the API Key from private app settings. |
| API Password rejected | Re-copy the API Password or create a new private app. |
| Resource access error | Confirm the private app has access to Products, Orders, Customers, and other selected data. |
| Wrong store URL | Confirm the Store URL matches the intended CommerceHQ store. |
| App deleted or disabled | Create a new private app and enter the new values in Next-Cart. |
Security cleanup
Section titled “Security cleanup”After migration work is complete and verified, remove the private app or reduce its access if it is no longer needed.
Next step
Section titled “Next step”| Situation | Go to |
|---|---|
| API values are ready | Verify Platform Connections |
| You need general API setup guidance | Set Up an API Connection |
| The connection test fails | Troubleshoot Connection Setup |