Listrak / Wonderment Integration Setup
Updated
by Brian Whalley
Setting Up the Wonderment / Listrak Integration
Today, Listrak’s API does not support some types of data objects, which means Wonderment’s triggers can link to a tracking page and contain shipping update information, but not precise data on what line items are in the shipment(s).
We recommend:
Using the Listrak / Shopify integration for your Shipment Confirmed event, or the native Shopify email for the Shipment Confirmed event. This will allow you to present a rich Shipment Confirmation message with the shipment contents. If you are already using this email, you can update it to link to your Wonderment tracking page.
You’ll use the Wonderment triggers for the other events. For example, the shipment error statuses, where you want to communicate that an error occurred and direct them to instructions.
Setting Up Wonderment-powered messages
You’ll use the Wonderment triggers for the other events. For example, the shipment error statuses, where you want to communicate that an error occurred and direct them to instructions.
- You can link to the tracking page from these messages, which will show the full shipment contents.
To integrate the other events, you’ll need to set up a new Cross Channel integration in Listrak. The steps are detailed below:
Steps:
- Log into Listrak
- Go to Integrations → Integration Management
Click “New Integration”. Create a new Cross Channel API integration.
Name it Wonderment. Disable IP Whitelisting.
Save. Your client ID and secret will fill in. The IP Address Whitelisting box might uncheck. That’s okay.
Copy the client ID and Secret down in a text document or similar, we’ll need them later. We must define the Wonderment events in Listrak before we can save these values into Wonderment.
Define Wonderment custom events following this table. These event names must match exactly. You must create all of the events, even if you don’t intend to use them right away. The list is provided in a table below for your convenience when copying and pasting.
Wonderment - Shipment Created | When a label has been created with a shipping carrier |
Wonderment - Label Cancelled | When a label has been cancelled with the shipping carrier |
Wonderment - Carrier Picked Up | When an order is first marked In Transit by the carrier. |
Wonderment - In Transit | For each in-transit scan the package has. |
Wonderment - Out For Delivery | When the carrier confirms the package has been handed off for delivery |
Wonderment - Ready for Pickup | When an order has been marked ready for customer pickup by the shipping carrier, such as at a local office or postal facility. |
Wonderment - Shipment Delivered | When the delivery scan has occurred for a package |
Wonderment - Returned to Sender | When a package has been sent back to the origin facility because it was undeliverable, damaged, or otherwise can't be completed. |
Wonderment - Attempted Delivery | If a package couldn't be delivered and was held by the carrier for re-delivery. |
Wonderment - Delivery Error | In case of a permanent delivery error, such as a non-existent address, or a package is lost or damaged at the carrier. |
Wonderment - Shipment Stalled | When a package hasn't made progress in the carrier network for a certain period of time, and is likely to be delayed. |
- For each event, you will need to define the properties to capture and make available for the email template. Click into each event to define the properties. You can safely skip event properties you do not intend to use. You can also come back and edit this later if you need to add more. It’s also fine to just add a few for testing the integration, and then add more when you’re ready to use them.
- When this is complete, your events will have a built out list of variables on each one. Similar to the event names above, these property names must match the table below precisely. The table is printed below for ease of copy/paste.
Event Data Property Name | Example Data | Notes |
| ups | Not usually used in email templates (Often this is what a 3PL inputs into Shopify) |
| Australia Post | |
|
| |
| ||
| ||
| this is an incomplete list of possible values | |
| 11/09/2022 04:57 | Only in Shipment Delivered |
(Can be formatted in Listrak templates - documentation) | ||
DestinationCountryCode | US | |
| 08/27/2022 | An ETA Provided by the carrier |
| ||
| 2022-09-07T20:43:00.000Z | A timestamp record of when the carrier reports the event occurring. (Can be formatted in Listrak templates - documentation) |
| 2022-09-19T15:46:35.000Z | UTC formatted timestamp. (Can be formatted in Listrak templates - documentation) |
| 25 | Only in Shipment Stalled events. |
The number of hours since the last reported movement of the shipment | ||
| 9/1/2020 2:46 PM ET | Only in Shipment Stalled events |
OrderCreatedDate | ||
| #AD12345 | The Shopify Order Name |
| 2113541212 | The Shopify Order ID |
ServiceLevel | Priority Mail | |
2nd Day Air® | this is an incomplete list of possible values | |
ServiceLevelCode |
| |
| this is an incomplete list of possible values | |
MarketingServiceLevel | Standard Shipping | |
Free Shipping | The shipping rate the customer chose at checkout | |
LineItemsCount | 3 | |
| A link to the customer facing Shopify branded orders status page | |
|
| |
| this is an incomplete list of possible values | |
| "Arrived at regional sort facility." | A human readable message you can safely include in your email template, provided by the carrier |
| 1Z111111 | |
| http://www.fedex.com/Tracking?language=english&tracknumbers=61290980851223631052 | This will match the URL in the Shopify admin order screen |
WondermentAdminShipmentPage | This is useful for internal notifications about specific shipments. | |
StorefrontTrackingURL | This is useful for showing the entire status of orders for Shopify app block pages. | |
Address1 | 123 Apple Road | Shipping Address Line 1 |
Address2 | Apt 16 | Shipping Address Line 2 |
City | Boston | Shipping City |
Country | USA | Shipping Country |
ShippingFirstName | Sample | Shipping First Name |
ShippingLastName | Customer | Shipping Last Name |
Zip | 02019 | Shipping postal code |
- You made it! Return to Wonderment and visit the Listrak integration screen: https://app.wonderment.com/settings/integrations/listrak
- Enter the client ID and secret into Wonderment that you got from Listrak earlier.
- Click save. You should see a success notification at the bottom of your screen.
Events will start flowing through for new shipment events - You can now go create your email templates.