Brandboom-AIMS360 FAQ


Brandboom Unlimited Yearly account

  • API Public Key
  • API Secret Key

AIMS brandboom module

Integrated Components

  • Orders
  • Products* (Manual importing/exporting required)
  • Customers* (Manual importing/exporting required)

Getting Started

  1. Contact Brandboom to enable integration for your account. Brandboom Unlimited Yearly Subscription is required for API use.
  2. Once a Brandboom customer service representative has enabled your account for integration, you will see all the information you need for integration on your Account page. Your Public Key, Secret Key, Account ID, etc, should now be listed under the section Integration.
  3. In your AIMS program, navigate to the follow section: Setup > System Settings > Brandboom Settings:
    • paste in the API URL.

      Sandbox environment:
      Production environment:
      *if you’re planning to test out with sample data and orders first, use your sandbox environment’s information.

    • paste in your Brandboom API Public Key and API Secret Key
  4. Export all your AIMS customers into an Excel sheet. Also export your AIMS skus into an Excel sheet.
  5. On Brandboom:
    • Go to the Customers page, choose Import and download the Customer Template. Paste in the columns from the AIMS Excel sheet into the Brandboom sheet without changing the Brandboom header column names. Make sure the Type column is properly filled out. “B” for billing. “S” for shipping. Leave it blank if both.
    • Go to the Products page, choose import and download the Products Template. Paste into corresponding columns and import.
  6. Import your customers into Brandboom. Confirm that the columns are transferred properly.
  7. Do the same for products. The unique 5-character ID for each SKU should be used as the SKU-Number on Brandboom. When importing into Brandboom, make sure that these unique AIMS IDs are listed under the “Sku Number” column on the Brandboom import template.
  8. Create and place a sample order. Mark the order as “Export.” The order should be available to AIMS within one minute. If the order failed to transfer, you should see the export status turn to red when you come back to the page
  9. In your AIMS program, navigate to the follow section: Modules > Third Party > Import Orders From Brandboom. Click Download to retrieve orders that have been marked as “Export” on Brandboom.
  10. Downloaded orders are split into two groups:
    • “Downloaded and Imported” : these are the orders that have been transferred into the AIMS system without any problem and they require no extra handling
    • “Downloaded and Not Imported” : these are the problematic orders that have been retrieved from Brandboom but are pending in the holding area because there are errors that need to be fixed

    Problematic Orders need to go through extra steps before they become valid and can be imported into AIMS. If you have problems, select the orders that you want to correct and click the next button.
    Orders that have missing or invalid Customer IDs will be presented. Resolve the problems by creating or select an existing customer. Click Next to continue.

    Finally, these orders are put into 4 views:

    • “All Orders” : entire list of orders just downloaded from brandboom
    • “Invalid Orders”: orders that still have errors. ex: invalid sales rep, invalid terms and conditions, invalid ship via, invalid style/color/size
    • “Valid Orders”: orders that have passed all validations and are ready to be imported
    • “Duplicated Orders”: orders that have the same Customer PO#

    Orders whose errors are all resolved can now be imported into AIMS.

  11. Eventually, as you have reviewed and finalized your orders in AIMS, you can now signal back to Brandboom if an order has been Shipped, Paid, Voided.
    • Navigate to: Modules > Third Party > Sync Orders With Brandboom
    • Select orders whose status you want to send back to Brandboom
    • Click the Mark Order As Shipped, Mark Order As Void, or Mark Order As Paid button

    *It’s recommended that you always send the status of an order back to Brandboom once you’re done with it in AIMS. That way, you will make sure the order statuses and analytics on Brandboom are accurate.

General Workflow

  1. Buyer visits presentations on Brandboom, and they place their orders.
  2. Seller reviews and edits orders on Brandboom.
  3. Seller has finished and finalized changes to orders
  4. Seller sets the order statues to export.
  5. Orders are sent to ready to be downloaded by AIMS
  6. Seller opens up AIMS and clicks Download in the Brandboom module.
  7. Orders are retrieved on AIMS. Seller fixes any order errors and finishes the transfer process.
  8. Seller reviews and finalizes orders in AIMS.
  9. Seller determines that the orders are final and should be closed out.
  10. Seller sends the order statues back to Brandboom using the Mark-As buttons.

Here you can create the content that will be used within the module.