Shopify Integration

The SmartConsign 2020 for Shopify allows you to use your existing carrier accounts with the Shopify order management software. The functionality of the Shopify integration includes:

• Create labels
• Print labels for direct printing
• Add a tracking number to the Shopify 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 Shopify storefront
• A SmartConsign Account

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

• Shop endpoint (xxxxxx.myshopify.com)
• Private App - API key
• Private App - API secret key
• Private App - Admin API access token
• Webhook Secret
• Shipping rates to map to services

Shipping rates can be found under Settings -> Shipping and delivery, then Manage rates. If the labels are expected to be created automatically, then your Shopify Rates must be mapped to the appropriate carrier services in SmartConsign, otherwise the order will be rejected.

If labels are not to be produced automatically, then use the unallocated option.

Additional settings to set up the shipper:

• Combine all products in a single shipment: Y/N
• Process only orders coming from specific locations: Y/N

If so, which one(s)?

• Create Unallocated shipment: Y/N

The default value for all these settings is N.

Unallocated shipments: Meaning the data imports without allocating the courier, courier service or producing the shipping label. The shipper can login to SmartConsign to complete the shipment and produce the label.

Using your Shopify admin page, navigate to the Apps page (on the left-hand side menu) – this has changed recently.

Click Develop apps for your store button which will take you the private apps list.

Create a new private app by clicking the Create an app button.

In the modal pop-up, enter a name i.e., “SmartConsign Connector” and click the Create app button. You’ll see the App Overview page.

Under API Credentials, get the API Key and Secret Key

Please keep / store these keys - you will require them again in this process

On the same screen, under Access tokens, click Configure Admin API scopes button.

Ensure that the scope Orders has both read and write

Once done that, ensure the following scopes have read and write access:

• Customers
• Fulfilment services
• Inventory
• Locations
• Merchant-managed fulfilment orders
• Order editing
• Products
• Shipping

Click Save button, you’ll see the Install app button becomes active.

Click Install app button and confirm by clicking the Install button in the pop-up.

By installing the app in the store, it will give you the access token, follow the instructions to reveal the access token. Please keep / store this token – you will require it again in this process

Navigate to Settings and then open the Notifications page.

Scroll down to the bottom and click the Create Webhook button.

In the open window change the Event to an “Order Payment” change Format to JSON and enter the following url:

https://shopify.smartconsign.io/api/ShopifyWebhook

into the URL, while keeping the Webhook API Version to the Latest.

Then, click the Save button.

If you would like to do this on Order Creation and not Order Paid then please follow the same instructions again and add the Event “Order Creation”

After saving, Please keep / store your webhook secret - you will require it again in this process (highlighted below in yellow)

Navigate to Settings and then open the Shipping and Delivery page.

Click Manage Rates and then add a new rate for each of the carrier services you will be using.

Each Rate can only be used for one service, you will be required to send a list of your Rates to SmartConsign along with a carrier service you wish to map it to.

Please forward all your kept / stored values to SmartConsign or Setup Provider to finalise the integration setup.

• Private App - API key (32 characters: letters and digits)
• Private App - API secret key (32 characters: letters and digits)
• Private App - Admin API access token (38 characters: letters and digits)
• Webhook Secret (64 characters: letters and digits)
• Shipping rates and carrier service to map to

To process shipping for an Open Order, you will need to click Add Shipping, which will bring up a list of your Rates. Choosing one of these Rates will automatically select the mapped Carrier Service for SmartConsign to create the shipment.

Graphical user interface, text, application

Description automatically generated

To generate the shipping label click The Mark as Paid button, this will send the order details to SmartConsign along with the mapped rate.

The Shipping Label will appear as a link in the Order Notes for you to download.

Cancelling an order will cancel the shipping label. Cancelation will vary on dates or status of the shipping label.

Please refer to the Shopify help guide for standard order operations - https://help.shopify.com/en/manual/orders

We have the following extra configuration options available on request:

• Convert Order To One Piece This always creates one label regardless of how many items there are in the order.
• Create Unallocated This imports your shopify orders into SmartConsign so you can create the label from there.
• Don’t add delivery Notes This stops SmartConsign from adding notes to your order, You will need to find and print labels from SmartConsign if this is enabled.
• Keep Original Note Value This keeps the original note value when adding note updates from SmartConsign.
• Process On Create This allows you to process orders on create rather then the default paid, It requires the “Order Creation” notification enabled which can be found in Configure Webhooks section.