Yotpo SMS & Email

https://support.yotpo.com/docs
Admin
Yotpo SMS & Email is a comprehensive platform for e-commerce businesses to manage SMS and email...
Tokens:345,445
Snippets:6,143
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Yotpo Extension via Composer

Source: https://support.yotpo.com/docs/adobe-commerce-2-installing-yotpo-reviews-extension-400

Run these commands in the Adobe Commerce 2 installation directory to install the combined module and update the environment.

```bash
composer require yotpo/module-yotpo-combined --no-update
composer update 'yotpo/*'
php bin/magento maintenance:enable
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento maintenance:disable
php bin/magento cache:flush
```

--------------------------------

### Install Star Rating for Clean Theme

Source: https://support.yotpo.com/docs/shopify-installing-the-yotpo-star-rating-on-product-pages

Specific implementation for the 'Clean' theme using the product-list-repeatable-item snippet.

```liquid
{%unless template contains 'product'%}
       {% include 'yotpoBottomLine' with product-list-repeatable-item %}
      {%endunless'%}
```

--------------------------------

### Customized Widget Instance Snippet

Source: https://support.yotpo.com/docs/referral-modules

Example of applying an additional attribute to the widget instance element.

```html
<div class="yotpo-widget-instance" data-yotpo-instance-id="0000" ***add-attribute-name=value***> </div>
```

--------------------------------

### Install Star Rating on Product Pages

Source: https://support.yotpo.com/docs/bigcommerce-stencil-installing-yotpo-reviews-on-stencil

Insert this widget code into product-view.html or single-details.html under the productView-title element.

```JavaScript
<div class=" yotpo-widget-instance" data-yotpo-instance-id=" {{INSTANCE ID}}" data-yotpo-product-id="
    {{ product.id }}">
</div>
```

--------------------------------

### Install Reviews Widget

Source: https://support.yotpo.com/docs/bigcommerce-blueprint-installing-yotpo-on-blueprint

Place this div element in ProductDetails.html to render the main reviews widget. If it does not appear, try adding it to ProductDescription.html instead.

```html
<div class="yotpo yotpo-main-widget" 
data-product-id="%%GLOBAL_ProductId%%"
data-price="%%GLOBAL_RawProductPrice%%"
data-currency="%%GLOBAL_CurrentCurrencyCode%%" 
data-name="%%GLOBAL_ProductName%%" 
data-url=document.URL 
data-image-url="%%GLOBAL_ThumbImageURL%%" 
data-description=""> 
</div>
```

--------------------------------

### Install Reviews Widget Instance

Source: https://support.yotpo.com/docs/adding-the-reviews-widget-to-shopify

Place this div element in your product template file to render the reviews widget. Ensure it is positioned correctly relative to the schema section or file end.

```JavaScript
<div class="yotpo-widget-instance" data-yotpo-instance-id="{{instance_" data-yotpo-product-id="{{product.id}}" data-yotpo-name="{{ product.title | escape }}" data-yotpo-url="{{ shop.url }}{{ product.url }}" data-yotpo-image-url="{{ product.featured_image | product_img_url:"large" |replace: '?', '%3F' | replace: '&','%26'}}" data-yotpo-description="{{ product.description | escape }}"></div>
```

--------------------------------

### Generic aggregate score retrieval example

Source: https://support.yotpo.com/docs/installing-rich-snippets-on-adobe-commerce-2

A simplified example for retrieving and displaying aggregate rating data.

```php
<?php $array = $this->helper('yotpo/richSnippets')->getRichSnippet($this); ?>
<?php if ($array["reviews_count"] != 0 ): ?>
 <div style="display:none" itemprop="aggregateRating" itemscope itemtype="http://schema.org/AggregateRating">
  <span itemprop="ratingValue"><?php echo $array["average_score"]; ?></span> 
  <span itemprop="reviewCount"><?php echo $array["reviews_count"]; ?></span>
 </div>
<?php endif; ?>
```

--------------------------------

### PHP Batch Request and Parsing Example

Source: https://support.yotpo.com/docs/in-line-seo

Demonstrates how to perform a batch API request to fetch widget data and render it within a server-side HTML template.

```php
<?php 
//This is an example batch request for app_key {app_key}, please remember to switch to your own. 
$url = 'http://staticw2.yotpo.com/batch';
//Building the batch data
$data = array('methods' => '
[{"method":"main_widget","params":{"pid":"295823037"}{"page":2}},
{"method":"bottomline","params":{"pid":"295823037",
  "link":"",
  "skip_average_score":false}}
 ]',
 'app_key' => {app_key});
// Also remember that the request method is HTTP POST, and that the request can be done on HTTPS and on HTTP. 
$options = array(
  'http' => array(
 'header'  => "Content-type: application/x-www-form-urlencoded\r\n",
 'method'  => 'POST',
 'content' => http_build_query($data),
    ),
    );
    $context  = stream_context_create($options);
    $result = file_get_contents($url, false, $context);
    // Parsing the response
    $response = json_decode($result, true);
    $main_widget = $response[0]["result"];
    $bottom_line = $response[1]["result"];
    // Now echo either one of $main_widget or $bottom_line variables, should yield the HTML of the relevant widget. 
    ?>
    <!-- We will now build a demo product page, with static HTML content pulled from the batch request above. -->
    <html>
    <head> 
    <script type="text/javascript">
    (function e(){
    var e=document.createElement("script");
    e.type="text/javascript",
    e.async=true,
   e.src="//staticw2.yotpo.com/{app_key}/widget.js"; 
    var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})();
    </script>
    </head>
    <body>
    <h1> My Product lt;/h1>
    <div
    class="yotpo bottomLine"
    data-appkey="{app_key}"
    data-product-id="295823037"
    data-name="Everything But Sticks"
    data-url=""   data-image-url="//cdn.shopify.com/s/files/1/0040/6842/products/EverythingBut1_large.png%3Fv=1382385048"
    data-description="....">
    <!-- this entire inner html will be overriden by the widget.js JS lib -->
    <?php echo $bottom_line ?>
    </div>  
    <h2> Reviews: </h2>
    <div 
    style="width:700px"
    class="yotpo yotpo-main-widget"
    data-appkey="{app_key}"
    data-product-id="295823037"
    data-name="Everything But Sticks"
    data-url=""
    data-image-url="//cdn.shopify.com/s/files/1/0040/6842/products/EverythingBut1_large.png%3Fv=1382385048"
    data-description="....">
    <!-- this entire inner html will be overriden by the widget.js JS lib -->
    <?php echo $main_widget ?>
    </div>
    </body>
    </html>
```

--------------------------------

### Install Specific Yotpo Plugin Version

Source: https://support.yotpo.com/docs/adobe-commerce-2-installing-yotpo-reviews-extension-400

Use this command syntax to install a specific version of the Yotpo plugin instead of the latest release.

```bash
composer require yotpo/module-yotpo-reviews:4.0.1
```

--------------------------------

### Embed Checkout Module Loader

Source: https://support.yotpo.com/docs/checkout-on-site-module

Include this script tag on your checkout page to load the Yotpo modules. Replace <YOUR GUID HERE> with your account's specific GUID.

```plaintext
<script src="https://cdn-
 		widgetsrepository.yotpo.com/v1/loader/<YOUR GUID HERE>" async></script>
```

--------------------------------

### Install Yotpo JavaScript

Source: https://support.yotpo.com/docs/bigcommerce-blueprint-installing-yotpo-on-blueprint

Add this script to the HTMLHead.html file to initialize the Yotpo widget. Replace ###YOUR-APP_KEY### with your unique Yotpo API key.

```html
<script type="text/javascript">
(function e(){var e=document.createElement("script");e.type="text/javascript",e.async=true,e.src="//staticw2.yotpo.com/###YOUR-APP_KEY###/widget.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})();
</script>
```

--------------------------------

### GET /baskets/{basket_id}

Source: https://support.yotpo.com/docs/setting-up-loyalty-referrals-on-sfcc-sfra

Retrieves information about the basket.

```APIDOC
## GET /baskets/{basket_id}

### Description
Retrieves information on the basket. This is used to understand which redemptions are part of the basket to determine how many points to present to the customer.

### Method
GET

### Endpoint
/baskets/{basket_id}
```

--------------------------------

### Install Yotpo Star Rating on Quickview

Source: https://support.yotpo.com/docs/bigcommerce-blueprint-installing-the-yotpo-star-rating-on-blueprint

Add this script and div to QuickViewContent.html. Ensure you replace ###APP_KEY### with your actual Yotpo API key.

```Markup
<script type="text/javascript">
(function e(){var e=document.createElement("script");e.type="text/javascript",e.async=true,e.src="//staticw2.yotpo.com/###APP_KEY###/widget.js";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})();
script>
<div class="yotpo bottomLine" data-product-id="%%GLOBAL_ProductId%%" data-url="%%GLOBAL_ProductLink%%">
div>
```

--------------------------------

### Install Yotpo Reviews Widget

Source: https://support.yotpo.com/docs/bigcommerce-stencil-installing-yotpo-reviews-on-stencil

Place this div element at the end of your product-view.html or product.html template file. Replace the placeholder with your specific Yotpo instance ID.

```html
<div class=" yotpo-widget-instance" data-yotpo-instance-id=" {{INSTANCE ID}}" data-yotpo-product-id="
    {{ product.id }}" data-yotpo-name=" {{ product.title }}" data-yotpo-url=" {{ product.url }}"
    data-yotpo-image-url=" {{ getImage product.main_image }}" data-yotpo-description=" {{ product.description }}">
</div>
```

--------------------------------

### Install Star Rating on Category Pages

Source: https://support.yotpo.com/docs/bigcommerce-stencil-installing-yotpo-reviews-on-stencil

Insert this widget code into card.html under the card-title element.

```JavaScript
<div class="yotpo bottomLine"
 data-product-id="{{id}}">
</div>
```

--------------------------------

### Create Redemption API Request

Source: https://support.yotpo.com/docs/implementing-redemptions-via-api

Example payload for the POST request to create a redemption in Yotpo.

```JSON
{
  "coupon_code": "YW74IFB8",
  "discount_amount": 10,
  "discount_amount_cents": 1000,
  "currency": "USD",
  "customer_email": "test@yotpo.com"
}
```
Tokens:
Raw