Learn the basics of how Spree integration works.

Who maintains the integration?

The Spree integration with Gladly is built and maintained by Upside.

Basic scope

Gladly reads Customer data such as name, contact information, and order details from Spree and adds them to the Customer's Profile.

Spree allows Customer purchases from verified/registered accounts and guests' purchases without signing into their account.

APIs used for the integration

The Lookup Adaptor is used to pull Customer and order details from Spree. A detailed technical overview of the integration can be found in the project repository.

How the integration works

As a pull-based integration, once connected to Gladly, Customer Profiles are automatically linked (if auto-linking is enabled) to matched accounts in Spree. Agents can also link a Customer Profile to Spree manually regardless of whether the Customer has a verified account or has only purchased as a guest.

Verified/registered vs. unverified guests
Verified (or registered) user accounts are Customers who created a user profile with their contact information. They typically log into their account first before completing a purchase. Guest Customers complete purchases without logging into their account. They provide identifying contact information like their email address during the checkout process. Because all purchases (verified or not) require an email address, Agents can still manually look up and link the Customer details from Spree to Gladly. If Auto-Linking is activated, Gladly can automatically sync Customer details from Spree into the Customer Profile.

The Spree connector supports returning the following Customer Profile properties. Remember that you can customize this by customizing the gem:

Customer profile showing lifetime value, order counts, and contact information details.

Name – Verified Customers only. This is empty for guest Customers.
Email – Verified Customers only. This is empty for guest Customers.
Phone – The default billing address phone number will be added to the existing phone numbers for verified Customers.
Address – Currently, if there are many addresses in Spree for a Customer, only one address can be synced with Gladly. Company names or phone numbers associated with an address are not synced.
Profile Link – Direct link to the Customer in the Spree admin panel. Only populated for verified Customers.
Order Count – Total number of orders made by the Customer both as a verified Customer and as a guest.
Guest Order Count – Total number of orders made as a guest without being logged into their account.
Lifetime Value – Total value of orders made both as a verified Customer and as a guest.
Member Since – Date when the Customer registered as a Customer. This is empty for guest Customers.

On top of the usual Gladly order fields in this integration, we additionally have the following fields:

Order Status - By default, only completed orders will be returned. You can, however, configure this here.
Guest – Whether the order was made through guest checkout.

Product Fields

On top of the usual Gladly product fields in this integration, we additionally have the following fields:

SKU
Unit Price
Total
Quantity

Events in the Conversation Timeline

By default, the connector supports sending two types of events into the Conversation Timeline: "Order Created" and "Order Adjusted" (e.g., refund). You can easily send additional events into Gladly by customizing the gem (developer support will be required).

Order details showing total, adjustment, and reason for return processing.

I'm using Gladly search and cannot find the events pushed from Spree. Why?