Brightpearl Integration

Edited

OVERVIEW

The integration between Brightpearl and Loop is a two-way integration, responsible for performing two primary actions:

  • Creates sales credits within Brightpearl when a return is initiated through Loop

  • Processes or flags returns within Loop based on inputs in Brightpearl


How it works

This integration creates sales credits within Brightpearl each time a return is initiated, and takes action within Loop upon item receipt by Brightpearl. When items return to the warehouse, Brightpearl sends Loop line item level information from which Loop triggers a processing event.

Getting started

To get started, please review Loop's Pricing and Packaging page to see if your plan includes this feature.. If this is not included in your current plan, please contact your Account Manager or support@loopreturns.com to see about adding this to your plan. 

Connecting Loop and Brightpearl

Follow the below steps to connect your Brightpearl account to your Loop admin:

  1. Reach out to your Merchant Success Manager or support@loopreturns.com and let them know that you'd like to use Brightpearl in Loop so they can ensure your account is set up to do so.

  2. Install the Loop app in Brightpearl's app marketplace.

  3. In the Brightpearl app in Shopify, turn OFF the setting Create Sales Credits from Returns. Turning this setting off will ensure that duplicate sales credits are not created for any returns created in Shopify, only for returns created in Loop.

Create an API key in the Loop Admin to use for the Brightpearl connection

  1. In the Loop admin, navigate to the Tools & integrations tab.

  2. Go to the Developer tools page, scroll down to the API keys section, and click Generate API key.

  3. Select the boxes next to the scopes: Order, Return, and Destinations (read).

    • Note: If you forget to check any of these scopes, you can edit this information later.

  4. Add 'Brightpearl' to the name of this API key. This name is for your own internal labeling convenience.

  5. Click Save.

    • Note: When the new API key is created, we recommend you copy this key because you’ll need to paste it in the next step.

Video walkthrough

Connect Brightpearl in the Loop Admin

  1. On the Integrations page, navigate to the tile labeled Brightpearl. This tile will include a toggle like most other tiles on the page.

    • Note: This is not the same tile from previous steps.

  2. Turn the toggle on. This will trigger a pop-up that will guide you through the next steps.

  3. Click Install. At this point you’ll authenticate your Loop and Brightpearl accounts.

  4. Click Connect next to Loop Returns.

  5. Paste the Loop API key that you created and copied in the previous step and click Connect. This will automatically route you back to the previous page.

  6. Click Connect next to Brightpearl.

  7. Enter your Brightpearl account username and click Connect.

    • If you’re logged into Brightpearl: Click Approve to approve the Loop to Brightpearl connection.

    • If you’re not logged into Brightpearl: You’ll be prompted to log in with your Brightpearl password. Once logged in, click Approve to approve the Loop to Brightpearl connection.

  8. You’ll be redirected to the next step.

Video walkthrough

Map Loop destination IDs to Brightpearl Warehouse IDs

This step is to ensure that the Brightpearl Warehouse ID listed on sales credits created from Loop is accurate. As a default, the Brightpearl Warehouse ID on the sales credit will be the same as it was on the original sales order.

Note: If you only have one warehouse or are fine with the default, this step can be skipped. 

If you have multiple warehouses and want to make sure the Warehouse ID data is correct on sales credits, you can easily create mappings by clicking the + button and inputting Loop Destination IDs with matching Brightpearl Warehouse IDs.

Finding the Loop destination ID

You can find the Loop Destination ID by navigating to a Loop destination and reading the numbers at the end of the page URL.

  1. In the Loop admin, navigate to Returns management > Shipping > Destinations.

  2. On the Destination that you're looking for the ID on, click Edit.

  3. In the URL, the numbers at the end are the destination ID for that Destination.

Map warehouse locations

  1. On Map Warehouse Locations, select Edit.

  2. Input IDs that you are currently using.

    • Note: Your configuration may include several blank fields depending on your setup. That’s to be expected. Only input IDs that you are currently using.

  3. Click Continue.

  4. Select Configure next to Receive Inventory, Create Payments, & Add Custom Fields.

  5. Using your existing mappings as a reference, answer the fields with Yes or No.

    • Important: Be sure to only input Yes OR No on any given field.

  6. Click Continue.

Video walkthrough

Returns Workflow

  1. Customer submits return to Loop.

  2. Sales credit is automatically created in Brightpearl as a child of the original sales order.

  3. Warehouse receives return package, updates status on the sales credit.

  4. Return is automatically processed in Loop.

  5. Sales credit "paid" amount is updated to the amount that was refunded to the customer. The reversal of payment is marked and timestamped in the Notes and Payment History.

    Note: The payment will be posted if the merchant has enabled payments on the configuration for the Loop <> Brightpearl integration.

FAQ

What plan do I need to be on to utilize this feature? This feature is included for merchants with access to integrations and/or Loop's API. If you do not have access and would like to add this feature, please contact your Merchant Success Manager or support@loopreturns.com.

Will I need a developer involved to complete this integration? Not at all!

Where can I find my Brightpearl Warehouse ID(s)? In the Brightpearl admin, the Warehouse IDs can be found under Settings > Products/Inventory > Warehouses. The page displays a list of warehouses with their names, IDs, and type.


Please reach out to support@loopreturns.com with any additional questions.