Set Up an API Connection

Set Up an API Connection

A valid API connection gives Next-Cart the authorized platform access required by the selected migration path. Complete API setup only when Next-Cart shows API fields for the Source Platform, Target Platform, or both.

An API connection lets Next-Cart access supported platform data through credentials created in the platform admin, developer area, integration settings, or authorization flow. The exact credential type depends on the platform.

Use the setup shown for your migration path

API setup is not a general replacement for KitConnect or source data file upload. Complete API setup only when Next-Cart shows API fields for the selected platform.

Prerequisites

Before you set up an API connection, confirm that:

• you are signed in to the correct Next-Cart account;
• the order and purchased migration show the correct Source Platform and Target Platform;
• Next-Cart shows API setup for the platform you are connecting;
• you can sign in to the platform admin, developer area, or integration settings;
• your platform account has permission to create or manage API credentials;
• you know which data types are in scope for the migration;
• you have a secure way to store and transfer credentials during setup;
• you know who will revoke or rotate credentials after completion.

Common API values

Different platforms use different credential names. Prepare only the values shown by Next-Cart for the selected platform.

Value type	What it usually means	Common examples
Store URL	The public, admin, or platform-specific URL that identifies the store.	Store URL, Admin URL, Site URL, Store Admin URL.
API URL	The endpoint used to access platform data.	API Path, API URL, Endpoint URL, Instance URL.
API key	A platform-generated key used to identify the connection.	API Key, Keystring, Application Key.
API token	A generated token that authorizes access.	Access Token, Auth Token, API Token, Application Token.
Client credentials	A credential pair used by some app or integration flows.	Client ID, Client Secret, App ID, App Key.
Account or merchant ID	A platform-specific account identifier.	Merchant ID, Account ID, Account Name.
Username/password pair	A platform-specific API user, not necessarily your admin login.	API Username, API Password.
Authorization result	A value created after approving access through the platform.	Authorization code, generated key, connected app token.

Exact fields vary by platform

Platform-specific API pages list the exact values to prepare for each supported platform. Use this general page for the API setup workflow, then follow the platform-specific guide when available.

Permission planning

Grant the minimum access required for the migration scope while ensuring Next-Cart can read or write the selected data where the selected platform requires it.

Migration data area	Permissions to check
Products and catalog	Products, variants/options, categories, collections, inventory, images, brands, manufacturers, attributes, or catalog resources.
Customers	Customers, customer addresses, customer groups, companies, or account-related customer records where supported.
Orders	Orders, order line items, transactions, refunds, fulfillments, order statuses, taxes, discounts, and shipping lines where supported.
Reviews, coupons, pages, or content	Reviews, discounts, coupons, CMS pages, blog posts, files, redirects, or content resources where supported.
Store information	Store metadata, currencies, locations, languages, taxes, or settings needed to interpret migrated data.

If a platform offers read-only access and the setup only needs source-side data reading, prefer read-only permissions. If the target-side setup requires creating data in the target store, the platform may require broader access.

Prepare API credentials

1. Confirm API setup is required

   Open the purchased service under Account → Migrations → My Migrations, select Start, and confirm that API fields are shown for the platform you are connecting.

2. Open the platform admin or developer area

   Sign in to the platform account that has permission to create apps, tokens, API users, private integrations, or authorization credentials.

3. Create a dedicated credential for Next-Cart

   Use a clear name, such as Next-Cart migration, so the credential can be found and removed later.

4. Set the required permissions

   Enable the permissions needed for the data types included in the migration scope. Avoid unrelated permissions when the platform lets you choose scopes.

5. Save or authorize the credential

   Follow the platform flow to generate the token, key, app credential, or authorization result.

6. Copy the required values immediately

   Some platforms show tokens or secrets only once. Copy the required values and store them in an approved secure location.

7. Enter the values in Next-Cart

   Paste the required values into the matching API fields shown by Next-Cart. Check the field labels before saving.

8. Run Test Connection

   In Connect Stores, select Test Connection for the API setup you entered. The Source Platform and Target Platform have separate controls, so test each side that uses API setup.

Enter API values in Next-Cart

When entering values, keep these rules in mind:

Rule	Why it matters
Match each value to the exact field label.	Similar credentials can have different meanings, such as API Key versus API Token.
Copy full URLs exactly.	Missing protocol, wrong admin domain, or incorrect endpoint path can cause connection failure.
Avoid extra spaces.	Leading or trailing whitespace can break tokens, URLs, usernames, and secrets.
Do not mix source and target credentials.	The Source Platform and Target Platform may each require different credentials.
Do not reuse stale tokens.	Expired, revoked, or old credentials often fail during verification.

Expected result

After API setup is complete:

• the required API values are prepared;
• the credentials have permissions for the selected migration scope;
• the values are entered into the correct Next-Cart fields;
• Test Connection succeeds for the applicable source or target store;
• credential cleanup is planned for after migration work is complete.

Verify the API connection

Use Test Connection before configuring migration options. Test the Source Platform and Target Platform separately when both use API setup. A successful result for one store does not verify the other.

Check	Pass condition
Source connection	The Source Platform Test Connection succeeds when the source store uses API setup.
Target connection	The Target Platform Test Connection succeeds when the target store uses API setup.
Authentication	Next-Cart accepts the API values for the tested side without authentication errors.
Permission access	Next-Cart can access the selected data type areas, such as products, customers, and orders.
Store identity	The connection points to the intended source store or target store.
Endpoint format	Store URL, admin URL, API path, or endpoint URL matches the platform-specific requirement.
Scope coverage	Credentials cover the data types selected for migration.
Token state	Tokens, keys, and authorization values are active and not expired or revoked.

If the API connection fails

Issue	What to check
Invalid credential error	Re-copy the token, key, username, password, client ID, or secret. Check for missing characters and extra spaces.
Permission error	Confirm the credential has access to the selected data types. Update scopes or create a new credential if needed.
Wrong URL error	Confirm whether the field requires a public store URL, admin URL, API URL, endpoint URL, API path, or instance URL.
Expired or revoked token	Generate a new token or repeat the platform authorization flow.
IP restriction or firewall error	Check whether the platform, hosting provider, or security layer blocks external access.
Wrong environment	Confirm that the credential belongs to the intended production, staging, or test store.
Platform rate limit	Wait, reduce repeated test attempts, or contact support with the visible error details.

Security cleanup

After migration work is complete and verified:

• revoke tokens created only for migration work;
• delete temporary private apps or API users where appropriate;
• reduce permissions on credentials that must remain active;
• rotate credentials that were shared for setup;
• remove credential screenshots or copied secrets from internal notes where possible;
• keep only the records required for support, finance, or audit purposes.

Do not store secrets in tickets unless requested through a secure path

Avoid pasting API tokens, secrets, passwords, Backup Codes, or private keys into unprotected messages. Use the secure sharing path requested by Next-Cart support when credentials are required.

Next step

Situation	Go to
You need platform-specific credential steps	API Connection Guides
You entered API values and need to test both stores	Verify Platform Connections
API setup is not shown for your selected Source Platform	Upload Source Data Files or Install KitConnect if shown by Next-Cart.
The connection test fails	Troubleshoot Connection Setup
The connection works and access is verified	Configure Your Migration