This tutorial is to help you integrate your Shopify E-commerce platform with Detrack using Detrack Connect.
With this integration, all selected orders from your Shopify storefront will be sent to Detrack for last mile tracking, capturing of real-time proof of delivery and more. You can also choose to set up the integration for the order’s delivery completion status to be feedback to your Shopify storefront.
Here’s how you can get started with the Shopify integration.
First, sign up for a Detrack Connect account.
- Sign up for a Detrack Connect account. If you already have a Detrack Connect account, continue with the next step.
- Go to the "Connections" tab and add a connection.
- Select "Shopify" as the Store/System.
- Fill in the fields below, the red circled fields are mandatory. If you are doing this integration to pass orders to your 3PL's Detrack account, ask your 3PL for the Detrack Group Name assigned to you as well as for the API key that belongs to your group. Refer to How To Generate The Detrack API Key For Detrack Connect.
- Next, go to your Shopify account to generate
- Store Name
- Shopify store API key
- Store Password
- Click on "Apps" from the side navigation bar.
- Click on "Manage private apps".
Refer to Manage Private App if you need permission to enable it.
- Click "Create new private App".
- Perform the following:
- Provide a "Name" and "Email" to the app.
- Select "Read and Write" for "Products" and "Orders" for Detrack Connect to update the order in your Shopify account. There will be a 403 or 422 error if permission is not granted.
- Click "Save" done.
- In the ensuing pop-up, click "Create app".
- At the admin API panel, copy the "API key" and "Password".
- Paste into the "Store" section of your Detrack Connect.
- Click on "Apps" from the side navigation bar.
- Click "Save" when done.
This webhook is for your storefront to send information to Detrack Connect.
- Click "Start by adding a webhook".
- Provide a name for your webhook and click "Save".
- This URL is the address for your storefront to send the information over via webhook. Copy the URL and head over to your Shopify account.
- In your Shopify account, scroll down to "Settings" at the bottom left corner and click "Notifications".
- Scroll down to the "Webhook" section and click "Create Webhook".
- Select the event (Shopify recommends using "Order fulfilment") for triggering the webhook PUSH notification and paste the Detrack Connect URL into the "URL" section and click "Save webhook".
When the order is marked as fulfilled or partially fulfilled in your Shopify admin and the shipment is in transit, this will trigger the Order fulfilment webhook for job creation in Detrack. You can also use other event triggers like "Order creation", "Order payment" or "Order update".
- At the webhook section, a special webhook signature from Shopify will be generated. Copy this signature from Shopify.
- Navigate back to Detrack Connect and click on the "Key" icon.
- Paste the copied Shopify "Webhook Signature" into the pop-up.
- Click "Save" when done, and the "Key" icon will turn green.
- You can check by creating a dummy order from your Shopify storefront, and fulfil it to test. If the setup is done correctly, it will be captured under Logs > Incoming Log.
In Detrack Connect
The connection setup has been created! Now you can configure the settings to filter the orders to be sent to Detrack, the shipping date and more right here.
This section is regarding the mapping of the statuses between Detrack and Shopify.
|Info received||On its way|
|Out for delivery||Out for delivery|
|Partially Completed||In Transit|
Below is the default field mapping between Detrack and Shopify. If you happen to be using other plug-ins, you may use the Mappings feature to perform custom mapping of data.
- Kindly note the following 3 required fields for job creation in Detrack:
This section is for use if you wish to retrieve certain field information from plug-ins to override the default field mapping.
Most of the plug-ins will be adding the information in the “note_attributes” key in the request payload.
- Create a dummy order from your storefront to Detrack Connect.
- There will be an entry under Logs > Incoming from your storefront.
- Click on the “Mappings” tab.
- Click the “Start by adding a mapping” button.
- A form will appear.
- Select the following:
- the “Order No” of the incoming log.
- the plug-in name.
- the Detrack field for mapping the information.
- Click “Save” when done.
- If necessary, repeat the above to perform more mappings.
For more information, refer to How To Use The Mapping Feature For Customized Data In Detrack Connect.
This section is regarding the mapping of the fields between Detrack and Shopify plug-ins.