- Keeping customers updated during shipping phase via email and/or SMS
- Displaying data relevant data from Ingrid for the shipping experience
- Creating customers in Engage from Ingrid if needed
Ingrid’s documentation
Ingrid maintain their own integration docs for this integration:See Ingrid's integration docs
Integrating Ingrid
Once Ingrid and Engage are configured, the integration is done as described below.Posting an order
Orders are posted by Ingrid to the Engage v2 endpoint:orderStatus from Ingrid in the payload, along with other useful information in extraData such as TrackingLinkHTML and TrackingNumber.
Creating a contact
It can happen that an order is posted to the Engage API but the contact doesn’t exist in Engage. A 404 response is then returned. If this happens, Ingrid will create the contact in Engage using this endpoint:/orders endpoint.
The default contactType is “Member” but this can be changed to whatever the merchant wants.
Building the automation
There needs to be an automation in place to handle incoming orders. This automation will handle the variousorderStatus values from Ingrid. To do this, you can have a value split in the automation to branch off the different order status values to send different emails, based on a contact’s current order status.
Building email templates
Create a specific email template for each order status you are going to handle. Use existing templates or design new ones with all relevant information and consistent branding and visuals. Use[[order.ExtraData.TrackingLinkHTML]] in your email module to embed the TrackingLinkHTML page code provided by Ingrid in the order. This will embed HTML into the email which shows the package’s location.
The [[order.ExtraData.TrackingLink]] value, if it exists in the order data, can also added to the email as a link to take the customer to Ingrid’s own tracking page for the item.
Frequently asked questions
Here are some common questions related to this integration.Why not use the v3/orders endpoint?
To build the integration as quickly as possible, the v2 endpoint was used, since the v3 endpoint was undergoing changes and iterations . However the v3/orders endpoint will be used in phase 2.Can I choose which statuses to handle from Ingrid?
Yes. you can choose, but the recommendation is to configure Engage to accept them all, and then decide in the automation engine what statuses to actually use.Can I use product images in the emails triggered by Ingrid?
Yes, if animageUrl for the item is provided in the order payload.