Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

WooCommerce Integration

Introduction

SmartConsign for WooCommerce allows you to use your existing carrier accounts with the WooCommerce order management software.

The functionality of the WooCommerce integration includes:

  • Create labels
  • Print labels for direct printing
  • Add a tracking number to the WooCommerce order record
  • Cancel and re-print labels where required

To get started with the application, you will require the following:

  • An account with your carrier
  • A WordPress website with WooCommerce Installed
  • A SmartConsign Account

Learn more about a SmartConsign Account

You will need to provide the following to SmartConsign for the initial setup.

Installing WooCommerce

Please refer to the WooCommerce installation guide at https://docs.woocommerce.com/document/installing-uninstalling-woocommerce/

Configure your Services

Navigate to Settings and then click the Shipping tab.

Edit the Shipping Zone and create new Shipping Methods. These will be used to map to your Carrier Services to create shipping labels.

Create a new Private App

Navigate to Settings and then open the Advanced tab.

Create a new Private App by clicking Rest API, Give the App a name enter a name i.e., “SmartConsign Connector” and the set the Permissions to Read/Write.

Click the Generate API Key button and this will create a Customer Key and Customer Secret, Keep both of these for later.

Configure Webhooks

Create a new Webhook by clicking Webhooks, then Add Webhooks.

Change the Topic to Order Created, Set the Delivery URL to: https://woocommerce.smartconsign.io/api/WooCommerceWebhook

Set the Secret to the Customer Secret from earlier but prefix with “webhooks_” Example: webhooks_114154757770146fb9bc973b1b67e1ea39cc9dc4

SmartConsign Setup

Please forward all your saved information to SmartConsign or Setup Provider to finalise the integration setup.

  • Customer Key
  • Customer Secret
  • Webhook Secret
  • Shipping rates and carrier service to map too

Label Management

To generate a label for an Open Order, you will need to click Add Shipping, Edit Item which will bring up a list of your Services. Choosing one of these Services will also choose the mapped Carrier Service for SmartConsign to generate the shipping label.

Setting the status to Complete and selecting the Create Order button will send the order details to SmartConsign along with the mapped Service and generate the shipping label. This will appear as a link in the notes for you to download. The shipping label will be cancelled when an order is cancelled. Cancelation will vary on dates or status of the shipping label.

Please refer to the WooCommerce help guide for standard order operations at https://docs.woocommerce.com/document/managing-orders