ShopBase API Connection

ShopBase API Connection

A valid ShopBase API connection gives Next-Cart the authorized platform access required by the selected migration path.

Next-Cart may ask for your ShopBase Store URL, API Key, and API Password. Prepare these values from a private app in the correct ShopBase admin.

Use the correct ShopBase store

If you manage multiple ShopBase stores, create or open the private app in the store that matches the migration path shown in Next-Cart.

When to use this guide

Use this guide when:

• ShopBase is the Source Platform or Target Platform in your selected migration path;
• Next-Cart shows ShopBase API setup;
• Next-Cart asks for Store URL, API Key, API Password, or related ShopBase connection values.

Prerequisites

Before you begin, confirm that:

Requirement	Why it matters
ShopBase admin access	You need access to the correct ShopBase admin.
Permission to manage private apps	The account must be allowed to create or view private app credentials.
Scope decisions	You need to know which data types Next-Cart must access.
Secure storage	API credentials should be copied only into approved secure locations.

Required values

Required value	Where to prepare it	Notes
Store URL	ShopBase admin or store domain	Use the URL format requested by Next-Cart.
API Key	Private app Admin API section	Copy the full value.
API Password	Private app Admin API section	Treat this value as sensitive.

Prepare the API connection values

1. Sign in to the ShopBase admin for the correct store.
2. Go to Apps.
3. Open Manage private apps.
4. Create a new private app.
5. Enter a recognizable app name for the migration service.
6. Enter an emergency developer email if ShopBase requires it.
7. In the Admin API permission area, enable read access for the data included in the migration scope, such as store content, customers, orders, products, discounts, inventory, and related areas where required.
8. Save and confirm the private app.
9. Copy the API Key and API Password from the Admin API section.
10. Copy the Store URL from the ShopBase admin or store domain shown by Next-Cart.

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	ShopBase store or admin URL requested by Next-Cart.
API Key	API Key from the private app Admin API section.
API Password	API Password from the same private app.

Expected result

The ShopBase API connection values are ready to test in Next-Cart.

Verify the connection

Check	Pass condition
Store match	The Store URL belongs to the selected ShopBase store.
Private app status	The private app is saved and active.
Permission coverage	Admin API permissions cover the data types shown by Next-Cart.
Connection test	Next-Cart can authenticate and read supported ShopBase data.

If the connection fails

Issue	What to check
Authentication error	Re-copy the API Key and API Password from the private app.
Wrong store	Confirm the Store URL belongs to the selected ShopBase store.
Missing data access	Review Admin API permissions and include the required data areas.
Private app unavailable	Confirm your ShopBase account has permission to create or manage private apps.

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

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