Cin7 Omni Integration

Overview

• This article outlines how to integrate your Cin7 Omni platform with Starshipit.
• Once completed, your orders can be imported into Starshipit and the tracking information will be written back when you print labels.

Table of Contents

• Activate Starshipit in Cin7 Omni
• Set up Cin7 Omni in Starshipit
• Set order statuses for import
• Importing Dimensions
• Troubleshooting
• FAQs

1. Activate Starshipit in Cin7 Omni

1. Ensure the Starshipit module has been installed as per the Cin7 Omni documentation.
2. Log into Cin7 Omni with your admin login.
3. Click on your username in the top right corner of the screen and select the Settings option in the drop-down.
4. Click on Integrations & API.
5. Select Starshipit from the list.
6. Make a note of the ID and Key as you will need to copy these into Starshipit.
7. Change any other settings as desired then click Save.

For more information on each setting please contact Cin7 Omni support.

2. Set up Cin7 Omni in Starshipit

1. In Starshipit go to Settings > Integrations > Add New > Cin7 Omni.
2. Tick Enable Cin7 Omni and Use dedicated API.
3. Enter your ID and Key gathered in Step 1 into the Cin7 Omni ID and Cin7 Omni Key fields respectively.
4. Click Test to ensure it works, to check if the connection is successful.
5. Click Save.

3. Set order statuses for import

You can specify statuses (known as stages in Cin7 Omni) on which Starshipit will import your orders from Cin7 Omni. For example, you can set the app to only import orders which are Processing and/or Fully Picked. You can also specify a custom import status by typing into the drop-down box. 

For Starshipit to be able to import orders from Cin7 Omni the below criteria must also be met on each order:

• Sales Orders are Approved.
• The fully dispatched field is empty on each Sales Order.

Provided these conditions are met you can import the orders directly into the New section of your Starshipit account.

4. Importing Dimensions

Starshipit can import item dimensions from the Cin7 Omni setup against your products. To configure dimensions in Cin7 Omni follow this guide.

1. By default, dimensions will be assumed to be in metres. If you are using a different unit of measure in Cin7 Omni, you can configure this from Settings > Integrations > Cin7 Omni settings >
   Linear measurement unit to convert from Cin7 Omni
2. Using our Package Setup section you can configure how Starshipit should handle the imported dimensions. For further information, please read this guide.

Troubleshooting

I clicked on test connection and I got an invalid credentials error message

Double-check that you have copied the correct information into Starshipit and that you have saved the information in Cin7 Omni. If this problem persists, contact our support team.

FAQs

Can I get my rates into my Cin7 Omni portal? 

Yes, you can get your Starshipit rates into your Cin7 Omni portal using the Cin7 Omni Rate calculator by following these steps:

1. Log in to Cin7 Omni.
2. From the Integrations menu in the navigation, open your Starshipit integration.
3. Open Settings.
4. Enter your Starshipit API key into the setting Starshipit API Key.
5. Enter your Starshipit subscription key into the setting Starshipit Subscription Key.
6. Under Package Options, recreate your Starshipit packages – Omni can’t download your Starshipit package details, so for the rates calculator to work accurately, you must re-define their specifications here.
7. Select Save.

Once you’ve configured the rate calculator, use it to see estimated shipping costs for your Starshipit couriers: 

1. Log in to Cin7 Omni.
2. From the Integrations menu in the navigation, open your Starshipit integration. You’ll see the rate calculator.
3. Enter the package’s destination (Ship To) and weight (Weight) in kilograms. 
4. Select Get Rates. You’ll see estimated shipping costs from your couriers under Shipping Rates Results.