This page will help you get started with Brandboom.

Request your API key

Contact Brandboom customer service to enable account integration. Once Brandboom has enabled your account for integration, you’ll see all the information you need for integration on your Account page. Your API Key, Account ID, etc, should now be listed under the Integration section.

Please note that your data and credentials will be different between your production and sandbox accounts.

🚧

Sandbox Account Testing Only

For safety reasons, this documentation's built-in API tester will only target the sandbox environment (brandboom.net). Accordingly, you must provide a sandbox API key to authenticate.

🚧

Production URL

When you're ready to switch over to production, please make sure that the base URL of your API calls is switched from manage.brandboom.net to manage.brandboom.com .

Set up a sandbox account

To set up a sandbox environment, get your sandbox credentials from a Brandboom admin. Log in at https://manage.brandboom.net and load test data as needed. You can import data by using import templates. Below are sample templates in the Excel format. They can be used with the frontend import widgets, located on the Product/Customer page.

📘

Sample Products Import Templates:

https://manage.brandboom.com/data/import/ImportTemplateProduct.csv
https://manage.brandboom.com/api/products?funcName=downloadImportTemplate&c=USD
https://manage.brandboom.com/data/import/ImportTemplateInventory.xls

📘

Sample Customers Import Template:

https://manage.brandboom.com/data/import/ImportTemplateCustomer.xls

Test drive API without coding

This documentation has a built-in API explorer. You just have to paste in your API key and input necessary parameters per each endpoint's documentation to test out endpoints.

Required parameters are marked with asterisks.