# Connect Cin7 Omni to Starshipit
URL: https://support.starshipit.com/articles/360001594575-connect-cin7-omni-to-starshipit
Canonical: https://support.starshipit.com/articles/360001594575-connect-cin7-omni-to-starshipit
Markdown: https://support.starshipit.com/articles/360001594575-connect-cin7-omni-to-starshipit.md
Updated: 2026-11-17

> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).

> Connect Cin7 Omni to Starshipit using the Dedicated or Public API. Find your credentials, set import stages and test the connection.

Connect Cin7 Omni to Starshipit to import sales orders and send tracking details back to Cin7 Omni when you print shipping labels. You can connect through the Dedicated API or the Public API.

## Before you begin

You need administrator access to Cin7 Omni and access to integration settings in Starshipit.

- **Dedicated API** is recommended for shipping. It uses the **ID** and **Key** from the Starshipit app in Cin7 Omni.
- **Public API** uses the username and connection key from **API v1** in Cin7 Omni. Use this option for [Cin7 Omni product sync and inventory writeback in Starshipit WMS](/articles/14700000000053-set-up-cin7-omni-with-starshipit-wms).

## Connect Cin7 Omni

Open the tab for the API you want to use.

<!-- tabs:start -->

<!-- tab:Dedicated API -->

1. In Cin7 Omni, install [the Starshipit app from the Cin7 Omni App Store](https://help.omni.cin7.com/hc/en-us/articles/9128571486095-Set-up-Starshipit) if it isn't already installed. Wait for Cin7 Omni to approve the installation.
2. Open your user menu in Cin7 Omni and go to **Settings > Integrations & API > Starshipit**.
3. Copy the integration's **ID** and **Key**. If you're setting up the app for the first time and need to generate a key, select **Reset Key**, confirm with **OK**, then select **Save** on both screens to reveal the credentials.
4. In Starshipit, go to **Settings > Integrations > Add New > Cin7 Omni**.
5. Turn on **Enable Cin7 Omni** and select **Use dedicated API (recommended)**.
6. Enter the **ID** and **Key** from the Starshipit app in Cin7 Omni into the corresponding fields.

<!-- tab:Public API -->

1. In Cin7 Omni, open your user menu and go to **Settings > Integrations & API > API v1**.
2. On the **API Setup** page, copy the **API Username** from the **Auth** section.
3. Select **Add New API Connection**, enter an **App Name** such as `Starshipit`, then save the connection.
4. Select **Copy** next to **API Key for Starshipit** on the confirmation page. Store the key securely before selecting **Back to Setup**. The key is only shown on the confirmation page.

   ![Cin7 Omni confirmation page showing the masked API key and the Copy button](/uploads/articles/starshipit-wms/web/warehouse-configuration/cin7-omni/api-key-confirmation.png)

5. Under **API Connections**, open **Permissions** for the connection you created. Enable the following permissions for shipping, then select **Save**.

   | Cin7 Omni resource | Permissions |
   | --- | --- |
   | **Sales Orders** | **Read** for order import and **Update** for tracking writeback |
   | **Products** | **Read** |
   | **Product Options** | **Read** |
   | **Branches** | **Read** if you select branches to import from in Starshipit |

6. In Starshipit, go to **Settings > Integrations > Add New > Cin7 Omni**.
7. Turn on **Enable Cin7 Omni** and select **Use Public API**. The option includes **(deprecated)** in UI 2.0.
8. Paste the **API Username** from step 2 into **API username** and the key from step 4 into **API connection key**.

See [Cin7 Omni's API connection guide](https://help.omni.cin7.com/hc/en-us/articles/10015165519503-Set-up-a-Cin7-Omni-API-connection) for help creating a connection or replacing a lost key.

<!-- tabs:end -->

## Set import stages and verify the connection

1. In the Starshipit Cin7 Omni settings, enter the Cin7 Omni order stages you want to import in **Import stage**. Use a semicolon between multiple stages, for example `fully picked;release to pick`.
2. Select **Save**.
3. Select **Test connection** (**Test to ensure it works** in Classic UI) and look for a success message.
4. [Import orders](/articles/206705193-import-orders) from Cin7 Omni. Use an approved sales order in one of your chosen stages with a blank **Fully Dispatched** date. Check that the order and its items appear under **New** in Starshipit.
5. When you print a label for that order, check that its tracking number appears on the sales order in Cin7 Omni.

## Configure optional settings

- **Import branches** (Public API in UI 2.0). After saving valid credentials, select **Load branches** if the list is empty. Select the branches to import from, then save your changes. Leave all branches unselected to import from every branch. For Dedicated API, choose the branches in the Starshipit app settings in Cin7 Omni.
- **Linear measurement unit to convert from**. Match the unit to your [product settings in Cin7 Omni](https://help.omni.cin7.com/hc/en-us/articles/9052674009231-Product-settings). Starshipit assumes metres if you leave the unit unset. Use [package settings](/articles/206705413-set-up-packages-and-import-weights-and-dimensions) to control how Starshipit uses imported dimensions.
- **Use staging URL** (Dedicated API). Use this option with Cin7 Omni staging credentials.
- **Map address line 2 into the Building field** (Public API). Find this under **Advanced > Field mapping**. Turn it on to import address line 2 into **Building**. With the setting off, address line 2 goes into **Suburb**.

## Troubleshooting

| Problem | What to check |
| --- | --- |
| The connection test returns a credentials error | Check that the API option matches your credentials. For Public API, use the **API Username** from **API Setup** and the key for the Starshipit connection. If you regenerate the key in Cin7 Omni, paste the replacement into Starshipit and save. |
| Cin7 Omni won't let you add another API connection | Contact [Cin7 Omni support](https://help.omni.cin7.com/hc/en-us/requests/new) if you've reached the API connection limit. |
| An order doesn't appear in Starshipit | Check the order's stage, branch and the date range you chose when importing. For Dedicated API, check that the sales order is approved and its **Fully Dispatched** date is blank. |
| Orders import but tracking doesn't write back through Public API | Open the connection's **Permissions** in Cin7 Omni and check that **Sales Orders** has **Update** permission. |

If the problem continues, contact [Starshipit support](/ticket) with the API option you selected and the error message or affected sales order reference.

## FAQs

<!-- faq:start -->

<!-- faq:question -->Can I see my Starshipit shipping rates in Cin7 Omni?<!-- /faq:question -->

Yes. To set up the rates calculator, open the Starshipit app in Cin7 Omni and go to **Settings**. Enter your [Starshipit API and subscription keys](/articles/360001893576-find-your-starshipit-api-key) in **Starshipit API Key** and **Starshipit Subscription Key**. Recreate your Starshipit packages under **Package Options**, then select **Save**.

To see estimated rates, open the Starshipit app from the **Integrations** menu in Cin7 Omni. Enter the shipment's destination in **Ship To** and its **Weight** in kilograms, then select **Get Rates**. Estimates appear under **Shipping Rates Results**.

<!-- faq:end -->
