The App Market Developer Hub

Welcome to the App Market developer hub. You'll find comprehensive guides and documentation to help you start working with App Market as quickly as possible, as well as support if you get stuck. Let's jump right in!

Email Marketing & Communications

This toolkit details how you can integrate reviews, ratings, visual user-generated content (UGC) and loyalty data into your marketing communications, including email, SMS, Messenger, and ads.

Here are the main use cases:

🚧

Please note:

  • Some merchants might also be interested in collecting reviews through your platform. To ensure the authenticity of the content collected, we do not currently offer this use case.
  • Each of the listed use cases requires that the customer has the applicable Yotpo Package (Reviews, Visual UGC, and Loyalty).

📘

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.

Integrate product data

Sync product data, including review quantity, average score, and top reviews and images between Yotpo and your platform in order to increase click-through rates on recommended products, abandoned cart messages, and more.

Display a product’s star rating and average score

Retrieve product data using the product or all products endpoints, either to display it in real time or to store it in your system. We recommend refreshing the data every hour or day.

These endpoints allow you to retrieve published data on products in the Yotpo system, including their average review score (average_score) and the total number of reviews written about them (total_reviews).

Get top product reviews and AI sentences

Use the best reviews or best sentences endpoint to retrieve your top product reviews. This endpoint will return only published reviews.

Make sure you provide the external_product_id parameter to pull relevant reviews about the actual product and not store or site reviews. Since these endpoints utilize an AI (NLP) engine that works on English reviews only, you can use the top reviews endpoint as an alternative endpoint for non-English language stores and as a fall-back when a product does not have enough reviews with a positive sentiment score.

Display visual UGC on a product

Display photos or videos that were handpicked and published by the brand on abandoned cart and promotional communications by pulling them from the product images endpoint in real-time or storing them while updating at least daily.

Integrate user data

Allow brands to segment customers and personalize messages in your platform using reviews and loyalty data from Yotpo.

Pull aggregate customer data across Yotpo reviews and loyalty

Yotpo’s new customer endpoints allow partners to pull a consumer’s record from Yotpo’s centralized CDP, combining loyalty and reviews data that is associated with the same customer (email) in the same eCommerce store. This data can be pulled by customer email address or in bulk for all records updated since a set date.

🚧

Please note:

Yotpo’s CDP updates once every 24 hours and will only return verified reviews. If you are testing your app using a test account, make sure to verify your email when creating reviews and wait 24 hours to successfully retrieve this data.

Pull all reviews & custom question for a customer

To also return all or the latest customer reviews, including answers to custom questions, you can retrieve all reviews and query by the customer’s email address or last update.

Keep users in sync

You can choose to sync data that updated in Yotpo daily or subscribe to Yotpo’s reviews and loyalty webhooks to keep your data up-to-date. This is described in more detail in the next section.

📘

Please note:

Use the include_nested parameter to include user data, for example, the user that wrote the review.

Trigger follow-up messages and flows based on review and loyalty events

Follow up on new reviews

Use the review_create webhook event to set up follow-up messages for new reviews that were just received from a customer. You can use the review score to create different follow-up flows for positive reviews vs. negative reviews.

🚧

Please note:

  • You may use the include_nested parameter to include user data, for example, the user that wrote the review.
  • According to Google’s reviews policies, site reviews cannot be incentivized in any way, while product reviews can. If you offer incentives through your platform, make sure to allow merchants to differentiate between site and product reviews using the review_type_id field in the response. When =1, the review is a product review and can be incentivized. When =2, the review was collected as a site review and must not be rewarded in any way.
  • Some merchants may also want to differentiate between verified buyer reviews, which are submitted automatically post-purchase and are therefore more authentic and valuable from a brand perspective, and anonymous reviews.

Announce to a customer that a review was published to the website

Use the review_updated webhook event to notify a consumer that their review was published on the website and bring them back to your website.

🚧

Please note:

The webhook only means the review was published if ‘deleted’ = ‘false’ for the first time. The webhook may trigger when later moderation changes are made to the review, which the brand might not want to trigger an event for.

Trigger emails and update customer profiles based on loyalty events and milestones

To start, the brand must implement their webhook URL for Yotpo Loyalty. Do this in the Settings area of the Yotpo Loyalty Admin.

🚧

Please note:

Multiple webhook URLs should be separated by a comma.

Once the webhook URL is placed in the admin, we recommend exposing all of these webhook events within your platform to both update the customer record and trigger loyalty emails.

Display brand-curated Visual UGC and top reviews by topic of interest

Visual UGC from an album

Display a gallery of photos or videos that the brand curated as a custom album. Just get the album ID from the photos or videos and then use the photos by album endpoint.

Top reviews and sentences on a topic

Use the best reviews or best sentences endpoint to retrieve your top reviews, while choosing the specific topics you’d like to include and exclude from the results. This endpoint will return only published reviews.

Updated 7 months ago

Email Marketing & Communications


This toolkit details how you can integrate reviews, ratings, visual user-generated content (UGC) and loyalty data into your marketing communications, including email, SMS, Messenger, and ads.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.