This article explains CommentSold's Open API: what it is, which plans include it, how to access it, and what to expect if you use it to connect your shop to other business tools. It's intended for shop owners and their developers or integration partners.
📘 Note
Open API is available on the Small Business and Large Business plans. It is a developer-facing feature - we recommend working with an in-house developer, development agency, or app partner to build and maintain integrations.
Overview
CommentSold Open API provides a secure, standardized way for external applications and services to connect with your CommentSold shop. It lets you extend CommentSold beyond its built-in features by connecting to other business systems, building custom applications, automating repetitive tasks, and combining CommentSold data with information from other platforms.
API access is shop-scoped, meaning each integration can only access the data and functionality it has been authorized to use for your shop.
Plan Availability
Open API is included on the following CommentSold plans:
| Plan | Price | Open API |
|---|---|---|
| Small Business | $499/month ($440/month with BH discount) | Included |
| Large Business | $999/month ($940/month with BH discount) | Included |
Small Business is the first plan tier that includes Open API access.
⚠️ Important
If you downgrade below the Small Business plan, Open API access is removed and any integrations that depend on it will stop working.
The Open API tab can be accessed by any user on your team, but any integration a user sets up is restricted by that user's own permissions. For example, if a user doesn't have permission to access orders, an integration they set up through Open API won't be able to access order information either.
Accessing Open API
You can access Open API from your CommentSold dashboard:
- From your CommentSold dashboard, select Setup.
- Select Open API.
Generate and manage credentials.
From the API settings, you can generate credentials and manage access for your integrations.
📘 Note
Open API is a developer-facing feature. You may need an in-house developer, development agency, or app partner to create and maintain your integrations.
How It Works
- Secure and scoped: Open API access is authenticated and limited to the CommentSold shop it's authorized for, so an integration connected to one shop can't access another shop's data.
- Supports multiple integrations: You can run several Open API integrations at the same time — for example, one integration that syncs inventory with a marketplace while another sends CommentSold data to a business intelligence dashboard.
- Requires development knowledge: Building and maintaining an integration requires technical expertise. Most shops rely on an in-house developer, agency, or app partner.
Limitations
- Open API is only available on the Small Business and Large Business plans.
- Open API requires development resources to build and maintain — it isn't a no-code/self-service feature.
- Downgrading below the Small Business plan removes Open API access and breaks any dependent integrations.
- Open API is user permission specific. This means it can be accessed by any user on your team, however integrations set up are restricted by the user's permissions. For example, if a user does not have permissions to access orders, any integration they set up with the Open API will not be able to access order information.
Frequently Asked Questions
What is CommentSold Open API?
CommentSold Open API is a developer-facing interface that lets external applications securely connect to your CommentSold shop, access authorized data, and automate business workflows.
Which CommentSold plans include Open API?
Open API is included with the Small Business and Large Business plans. Small Business is the first plan tier that offers Open API access.
Where do I find Open API in CommentSold?
In your CommentSold dashboard, go to Setup > Open API.
Can Open API access another shop's data?
No. Open API access is shop-scoped, so an integration can only access the data and functionality authorized for the connected shop.
Can I connect multiple integrations to CommentSold?
Yes. You can use Open API for multiple integrations simultaneously, including integrations for marketplaces, inventory systems, business intelligence tools, and custom applications.
Can Open API automate inventory and order management?
Yes. Developers can use Open API to build integrations that automate workflows such as inventory synchronization and order processing.
Can I use Open API to create custom reports?
Yes. CommentSold data can be connected to business intelligence tools, data warehouses, or custom dashboards to create specialized reports and analytics.
Do I need coding knowledge to use Open API?
Open API is a developer-facing feature, so building and maintaining an integration requires development knowledge. Most shops work with an in-house developer, agency, or app partner.
What happens to Open API if I downgrade my plan?
If you downgrade below the Small Business plan, Open API access is removed. Any integrations that depend on Open API will no longer be available.