Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Home
  2. /
  3. Channels
  4. /
  5. Shopify Integration

Shopify Integration

Introduction

The SmartConsign – Shopify integration allows you to import Shopify orders directly into the SmartConsign portal, where shipments are created and managed manually.

⚠️ Important: The Shopify integration is now configured entirely from the SmartConsign portal.
There is no longer a separate external connector to configure.

This integration focuses on reliable order import, manual shipment control, and clean Shopify timelines.

Prerequisites

Before starting, ensure you have:

  • A Shopify storefront
  • A SmartConsign account with portal access
  • Shopify permissions to create apps and webhooks

Integration Overview

Once the integration is active:

  • Orders created in Shopify are imported into SmartConsign.
  • Each order creates an Unallocated Shipment.
  • Shipments and labels are created manually in SmartConsign.
  • Tracking information is automatically fulfilled back to Shopify once the label is created in the SmartConsign portal.
  • No SmartConsign notes are added to the Shopify order timeline.

Setting Up the Shopify Integration

Step-by-step

  1. Log in to the SmartConsign Portal
  2. Navigate to
    Channels → Manage Channels
  3. Locate Shopify and click Add Integration
  4. A new window will open
  5. Fill in all required fields with valid values
  6. Click Create Channel

That’s it 🎉 — the integration is now active.

Required Information

When creating the channel, enter the values exactly as shown in the SmartConsign portal UI.

SmartConsign Field Shopify Value
Private App API Key Private App – API key (32 characters: letters and digits)
Private App Password Private App – Admin API access token (38 characters: letters and digits)
Private App Secret Private App – API secret key (32 characters: letters and digits)
Webhook Secret Webhook Secret (64 characters: letters and digits)
Endpoint URL yourstore.myshopify.com

All values are entered directly in the SmartConsign portal.

Shopify App Configuration

Creating a Private App

A Shopify app is required to allow SmartConsign to access your store data.

  1. In Shopify Admin, go to Settings → Apps
  2. Click Develop apps for your store
  3. Click Create an app
  4. Name the app (e.g. SmartConsign Integration)

Configure API Scopes

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.

Under Admin API scopes, enable read and write access for all of the following:

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

⚠️ All scopes listed above are mandatory.

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

After installation, should have the following values:

  • API Key
  • Admin API access token
  • App secret

These values are required when creating the SmartConsign channel.

Configure Webhooks

SmartConsign uses Shopify webhooks to receive order events.

  1. In Shopify Admin, go to Settings → Notifications
  2. Scroll down to Webhooks and click Create webhook
  3. In the opened window, configure the webhook as follows:
  • Event: Order Payment (default and recommended)
  • Format: JSON
  • URL:
    https://shopify.smartconsign.io/api/ShopifyWebhook
  • Webhook API Version: Latest
  1. Save the webhook

After saving, copy and store the Webhook Secret — this must be entered in the SmartConsign portal.

Default Integration Behaviour

The following behaviour is applied automatically:

  • Shopify orders create Unallocated Shipments in SmartConsign
  • Shipments are completed manually in SmartConsign
  • No SmartConsign notes are added to Shopify
  • Tracking is automatically fulfilled back to Shopify once generated

Important: To generate the import and pull orders into SmartConsign, click the Mark as Paid button in Shopify. This action sends the order details to SmartConsign.

What is an Unallocated Shipment?

An unallocated shipment means:

  • No carrier or service is assigned automatically
  • No label is generated
  • The data is imported without allocating the courier, courier service or producing the shipping label.
  • The user completes shipment details and generates the label in SmartConsign

Label & Shipment Management

Label creation and shipment processing are handled entirely in SmartConsign.

  • Orders import as Unallocated Shipments
  • The shipper selects carrier and service in SmartConsign
  • Labels are generated manually
  • Tracking automatically fulfils the order in Shopify
  • Shopify timelines remain unchanged

Cancelling or modifying shipments is managed in SmartConsign and may depend on carrier rules.

For standard Shopify order actions, refer to:

https://help.shopify.com/en/manual/orders

Notes & Limitations

  • Shipping rate mapping is not required
  • Automatic label creation from Shopify is not supported
  • Processing is triggered via webhook (Order Payment by default)

Support

If your Shopify environment has specific requirements or you need assistance, please contact your SmartConsign setup provider or support team.