This toolkit details how you can integrate Yotpo Reviews and Yotpo Loyalty & Referrals with your shipping or returns platform to create seamless consumer experiences that allow merchants to fully benefit from both solutions.

Here are the main use cases covered in this guide:

Yotpo Reviews

• Update the time of Yotpo Post Purchase Review Request Email.
• Display star ratings on purchased products and recommended products on an order tracking page or widget.

Yotpo Loyalty & Referrals

• Reward a customer with loyalty points when a shipment was delayed or incentivize them to choose a different shipment or return option.

👍

Have you registered your app yet?

Before you start building your app on top of Yotpo’s App Market API, you first need to register it with us. If you haven’t done so yet, refer to the steps in our Welcome guide.

Yotpo Reviews

Update the time of Yotpo post-purchase review request email

Yotpo receives orders from eCommerce platforms based on different order statuses and enters these orders into a queue for post-purchase emails to be triggered a set number of days later, according to the setting defined in your Yotpo account. Merchants that are on Shopify can also leverage delivery statuses that are already available in Shopify.

Yotpo’s system checks each order that has not yet triggered a review request on a nightly basis (at midnight GMT), to see if the order status or fulfillment date has changed. Please note, we require all items in the order to be fulfilled before we receive it from Shopify.

Merchants typically want to trigger review requests only once they know an order has been delivered. If you are updating the shipping status in Shopify directly to “delivered”, then this information will be passed to Yotpo by default and the merchant can trigger their review request emails based on that status.

If you are not updating the status in Shopify (or the eCommerce platform) directly, you can update the shipping status directly in Yotpo. To do so, you’ll need to make the following API calls to update the timing of a review request:

1. First, retrieve the order to get the Yotpo ID ('yotpo_id' nested under “orders”).
2. Once you have the 'yotpo_id' from the previous call, you can retrieve the order fulfillment to get the order details and Yotpo Fulfillment ID (“yotpo_id” nested under “fulfillment”)
3. Now, update the order fulfillment using the Yotpo Order ID and Yotpo Fulfillment ID. The call is a “Patch” so you can update just the relevant information, in this case, the "shipment_status" will need to be set to “delivered” to start the count in Yotpo for the review request sent.

Once the order was set to 'delivered', the review request will be added to the cue and this status can not be changed/postponed.

Display star ratings on purchased products and recommended products on an order tracking page or widget

To easily implement this use case, follow the relevant section of the “Product Recommendations” best practice guide.

Yotpo Loyalty & Referrals

Reward a customer with loyalty points when a shipment was delayed or incentivize them to choose a different shipment or cancellation option

Allow merchants to configure a campaign that will automatically reward the customer with loyalty points (and trigger messages/info into the Help desk cases you open) to notify the customers of the automatic reward.

This can be done using Yotpo’s custom action API (the merchant needs to configure the custom action in Yotpo as described here).