Lesson 1: Install + Setup

This guide will take you step-by-step through installing and setting up the Magento Integration with Brightpearl. You will learn how to:

1. Sign up to Brightpearl Ecommerce
2. Install the Magento Integration
3. Add API information in Magento
4. Create a sales order status in Brightpearl
5. Add a Magento store in Brightpearl
6. Edit your Brightpearl sales channel

Watch this video, or follow the steps below:

Note: We are always working to improve how things work in Brightpearl, so you may notice some changes since this video was produced, but you can find all the details in the written guides.

1. Sign up to Brightpearl Ecommerce

Before you can start using any of our online sales channels you will need to subscribe to Brightpearl Ecommerce; this is free during your trial period.

1. Go to Setup > Company > Billing details.
2. Tick the checkbox to buy the Ecommerce package.
3. Click the Enter payment details button and follow these on-screen instruction to upgrade your account.

2. Install the Magento Integration

After you have subscribed to Brightpearl Ecommerce you are free to install any of our integrations (we will be adding more). To install the Magento Integration:

Please contact us to get the Magento extention, raise a Support Ticket.

3. Add API information in Magento

Assuming you already have a Magento account you will first need to confirm that your Magento store will allow Brightpearl access over API, basically, will your Magento account talk to your Brightpearl account (using what are called “Web Services”). To check this this, type this address (with your own store name) into your web browser:

Magento Go:

http://www.mymagentohost.com/api/v2_soap?wsdl=1

Magento Community:

http://www.mymagentohost.com/store/api/v2_soap?wsdl=1

(change mymagentohost to the name of your store)

If you get a load of HTML code displayed it means it is working. As long as you get some message back, you have API access. If you don’t get a response from this URL, please contact the person that installed your Magento system and ask them to enable the SOAP extension.

Next you need to create a Role and User in Magento. This is a bit like giving a staff member access, but rather than it being an actual person, it's your Brightpearl account! This is how Brightpearl is able to upload and download data to and from your Magento account.

Create a Role

1. In Magento, go to System > Web services > Roles (Magento Community - select SOAP/XML-RPC-Roles).
2. Click the Add New Role button.
3. Give the Role a name, “Brightpearl” would be fine.
4. Click the Role Resources menu on the left.
5. Define the resource access. Select All or Custom from the dropdown menu. Brightpearl will need as much access as possible.
6. Click the Save Role button.

Note to Magento Community 1.6.x users: There is a bug with Magento where the role resources won't save. You will need to use a patch to fix this, please refer to the Magento Community forum for this patch.

Create a User

1. In Magento, go to System > Web services > Users (Magento Community - select SOAP/XML-PRC-Users).
2. Click the Add New button.
3. Make the following entries and keep a note of each, you'll need them later:
   • Username - we’d suggest “Brightpearl”
   • Firstname and lastname - anything you like
   • Email address - it doesn’t matter but we’d suggest you use an address where you can check the emails
   • API key - create a password for the user, it needs to be at least 6 characters long without spaces
4. Click the User Role menu on the left, and select the role you created a moment ago (“Brightpearl”).
5. Click the Save User button.

Settings

You will also need to set the WSI-Compliance.

Note: Not applicable for Magento Go.

1. In Magento, go to System > Configuration > Magento Core API.
2. In the WSI-Compliance field select No.
3. Save the configuration.

4. Create a sales order status in Brightpearl

Sales Order Statuses are used for tracking where your orders come from, such as eBay, Webstore or by phone, and at what stage they are in the sales process, such as New, Invoiced, Complete. You'll probably find it useful to have one especially for any orders you get through Magento so you can easily see how well your site is generating business. This status can be automatically picked up by new Magento orders.

To create a new status:

1. Go to Setup > Sales > Sales Statuses.
2. Enter a name for the status, for example "New Magento Order".
3. Use the colour wheel to colour code the status.
4. Click Add new status.

5. Add a Magento store in Brightpearl

For each of your Magento sites you will need a "Store" setup in Brightpearl. Currently we only support a single store, but we'll be introducing multi-storefront integration in the future.

For this bit you will need those API details (Role and User) you created in Magento earlier.

Go to Setup > Channels > Setup: Magento and click the Add store button. Make the following entries:

Now Save!

After you have completed the above fields you must SAVE your changes. This automatically creates a Magento Store Sales Channel in Brightpearl. Channels are used for monitoring where your sales orders come from; when we launch support for multiple storefronts (very very soon!), you’ll be able to create a channel for each of your Magento stores. Right now you can only have one Magento channel.

6. Edit the Magento sales channel in Brightpearl

A Magento Sales Channel is created for you as soon as you have created a Magento Store (as above). When we introduce multi-storefronts you'll have a channel per store.

Not only can the Sales Channel be used for reporting on your sales, but it defines the Brightpearl Warehouse used for inventory management (you may only have one) and the Price List, so you should confirm the settings are right before you go any further.

Go to Setup > Channels > List channels and click the edit pencil next to the Magento channel - it will have the same name as the store you created earlier:

This channel will automatically be applied to orders generated from Magento, allowing you to report and monitor you Magento site sales.

Check your Magento store URL by logging into Magento and going to System > Configuration > Web > URL Options > Active domain. This is what you'll need to enter in Brightpearl:

1. In Brightpearl, go to Setup > Channels > Setup: Magento.
2. Click to edit your store.
3. In the Store URL field update your Magento store URL, making sure to include the "www.".
4. Scroll down and save the changes.

That's it!

If you want to check if it's connected and working, go to your Magento Dashboard in Brightpearl at Setup > Channels > Magento dashboard. Any problems will be displayed at the top of the screen like this one. So no errors...no problem.

Next we'll look at connecting up all your data...