How to integrate with WooCommerce

Overview

  • This article outlines how to integrate Starshipit with WooCommerce so you can import WooCommerce orders.
  • Learn how to disable email notifications in WooCommerce.

1. Generate your API key in WooCommerce

In order to import orders from your store, Starshipit needs some information which can be found in your WooCommerce dashboard.

  1. From your WooCommerce dashboard, select WooCommerce > Settings.
  2. Click the Advanced tab.
  3. Select REST API near the top of the screen, then click Add Key.
  4. In the Description field, enter Starshipit Integration.
  5. Select a user.
  6. In the Permissions menu, select Read/Write.
  7. Click Generate API key.
  8. Copy the Consumer Key and Consumer Secret. You will have to paste this in the Starshipit integration settings.
If you want to use the Legacy Version 1 or Legacy Version 2 integrations, you will need to enable the Legacy API on WooCommerce. Using the legacy integrations is not recommended.
  1. From your WooCommerce dashboard, select WooCommerce > Settings.
  2. Click the Advanced tab.
  3. Click Legacy API near the top of the screen.
  4. Tick Enable the legacy REST API.
  5. Click Save changes.

2. Add WooCommerce as an integration in Starshipit

  1. In your Starshipit account, go to Settings > Integrations.
  2. Click Add a new integration, and select WooCommerce from the list.
  3. Select the Enable WooCommerce checkbox.
  4. Under WooCommerce API version, select Latest Version 3.
  5. Enter your store URL.
    If you do not know your store URL, check your WooCommerce dashboard > Settings > General > Site Address (URL).
  6. Paste your Consumer Key and Consumer Secret copied from WooCommerce.
  7. Enter or select your Status to import.
  8. Fill out any other details as required. 
  9. (Optional) Select Enable writeback to the customer instructions field. Starshipit will write-back the Tracking Number, Carrier Name and Tracking URL in the instruction field.
  10. (Optional) Select Enable customer notifications when creating order note on writeback. Customer notifications will automatically be sent when Starshipit writes back the tracking details in a note.
  11. Click Save.

3. Set your writeback method

Writeback is when Starshipit sends back tracking information to WooCommerce. Learn more information about writeback here.

With the Latest Version 3 WooCommerce integration you can configure two different writeback methods.

To configure your writeback method follow the below steps:

  1. In your Starshipit account, go to Settings > Integrations.
  2. Click Settings next to WooCommerce.
  3. Scroll down until you see the option Writeback Method.
  4. From the dropdown select either of the two options:
    • Create an Order Note
    • Update using Shipment Tracking Plugin

Create an Order Note

When an order in Starshipit is printed or manifested, Starshipit will set the order status to complete in WooCommerce, and add an order note to the order.

You can also set the order note created to also trigger a notification to the customer. To do this enable the Enable customer notifications when creating order note tickbox option in WooCommerce settings when you have the Create an Order Note writeback method selected.

Update using Shipment Tracking Plugin

This method allows you to use the WooCommerce Shipment Tracking Plugin. The plugin adds tracking fields into WooCommerce as there are no native fields on WooCommerce.
You can purchase the plugin and find instructions for installing it here.
mceclip2.png

By using the plugin to add these fields, you can setup other integrations with WooCommerce (like Amazon, eBay and The Iconic) to read from these fields for the purpose of writing back to those platforms when an order is shipped.

4. Import WooCommerce orders

  1. From the Starshipit Main Menu, select Orders.
  2. Click Import at the top right of the screen, and select Import Orders from the dropdown menu.
  3. Select WooCommerce, and enter the number of days you want the importer to check for orders.
  4. Click Import. Starshipit imports the orders based on your Status to import selection for WooCommerce e.g. Processing.
  5. Click Close once importing is complete.

(Optional) Disable email notifications in WooCommerce

Should you choose to use Starshipit branded notifications, you can disable email notifications from being triggered to be sent by your WooCommerce store.

  1. From your WooCommerce dashboard, select WooCommerce > Settings.
  2. Select the Emails tab.
  3. Select the order email template you would like to disable. e.g. Completed order.
  4. Clear the Enable this email notification checkbox.
  5. Click Save changes.

(Optional) Import additional product attributes

You can also import the size and colour of your products from your WooCommerce store by using WooCommerce Product Attributes. 

  • Starshipit relies on the attributes being labelled "Size" and "Color" specifically for these to be picked up by the importer.

Partial Shipments are not supported with this integration. 

What's next?  

If you're having issues with the integration, see WooCommerce - troubleshooting.

Want to deliver great shipping experiences?

Start a 30-day free trial or book a demo with one of our shipping experts

Was this article helpful?
2 out of 3 found this helpful

Comments

1 comment

  • What is the reasoning for disabling Woocommerce Processing emails? What examples could be given in this circumstance?

Please sign in to leave a comment.