Who Is This For?
StoreHub merchants who want to connect their own system or app to StoreHub using the StoreHub API, and want to know which plan they need.
Overview
API access is included in the Advanced and Pro plans. It is not included in the Starter plan. If you are on Starter and want to use the API, upgrade to Advanced or Pro first.
To get API access, you ask StoreHub Care for an API key. An API key works like a password for your system. It is not your BackOffice login. The API lets your system get your StoreHub data, such as products, customers, inventory and transactions.
Before You Begin
You are on the Advanced or Pro plan. API access is not included in the Starter plan or in older plans, such as Lite or Base.
To check your plan, see Check Your Current Subscription Details. To upgrade, see Upgrade Your Subscription Plan.
You know what you will use the API for, for example which software you want to connect. StoreHub Care will asks for this.
You can send email from your account's main or master email address. This is the email used to create your StoreHub account.
Step-by-Step Guide
Ask StoreHub Care for an API Key
You can ask for an API key on the Advanced or Pro plan. API access is not included in the Starter plan.
1. Contact Customer Care on live chat from your StoreHub app or BackOffice, or by email ([email protected]), and ask for an API key using your account's main or master email address.
2. Tell Care what you will use the API for.
3. Wait for Care's email. StoreHub emails the API key to you once it approves your request. The email comes from [email protected], with the subject "Your API Access Information has arrived". If you do not see it, check your spam or junk folder.
Note:
StoreHub then sends the API documentation to you in a separate email.
Connect Your System with Your API Key
Give these details to the person who sets up your system. To connect, send your account name as the username and the API key as the password, using Basic authentication.
Username: your account name. It is the first part of your BackOffice web address, for example 'mystore' in mystore.storehubhq.com. Care's email shows it next to 'Username'.
Password: your API key. Care's email shows it next to 'Password'. Copy it exactly, with no space before or after it.
What the StoreHub API Covers
The list below shows the data you can get from the StoreHub API.
Products: one GET request lists all your products and another returns a single product by its ID.
Customers
Inventory by store
Transactions: you can limit this request by date range and store, and each transaction it returns lists its payments with the payment method and amount.
Employees
Stores
Payment options
Promotions
For details on each request, see the API documentation that StoreHub Care emails you.
Troubleshooting
The table below covers a common problem when connecting to the StoreHub API with your API key.
Problem | Solution |
My API requests are refused with a 403 error | Check that the API key has no space before or after it. Check that the username is your account name, for example 'mystore'. If requests are still refused, contact StoreHub Care and say which request you sent. |
FAQs
1. Can I use the StoreHub API on the Starter plan?
API access is not included in the Starter plan or in older plans, such as Lite or Base. It is included in the Advanced and Pro plans. To use the API, upgrade to Advanced or Pro first.
2. Where can I find the StoreHub API page or API documentation?
StoreHub sends you the API documentation by email, in a separate email after your API key. To start, ask StoreHub Care for an API key from your account's main or master email address. Tell Care what you will use the API for.
Need Help?
Contact StoreHub Support via live chat in your StoreHub app or email [email protected].
Was This Article Helpful?
Let us know below or contact support for further assistance.