Product Review File Format

XML file format used for Custom Ratings and Reviews Integrations

Support avatar
Written by Support
Updated over a week ago

The Ratings and Reviews solution incorporates your best reviews into email campaigns, including Shopping Cart Abandonment and product-specific campaigns.

A custom XML feed can be used to send the review information to Listrak. Learn more about the process and how to format the XML feed below.

Custom XML Feed Process

The following process will be used to complete the integration:

  1. Provide Listrak with a sample review file using the .xml formatting detailed below.

  2. Listrak verifies that the sample file is formatted correctly before the feed is scheduled.

  3. Upload your approved custom review .xml file to the Listrak FTP using your credentials.

  4. Set up the feed for the full file to send once a day, if you have a large review file, batching it to send out at low traffic/system activity times is ideal (2-3am).

Formatting Tips

  • Handling Products That Contain Reviews: All nodes displayed in the XML example directly below must be included in the XML document to successfully import. All 'fullreview' nodes must be passed, but a value can be left blank if not provided (for example if location is not required when leaving a review).

  • Handling Products That Do Not Contain Reviews: If no review is included, the 'fullreview' nodes can be removed for the specific product. The 'review' nodes must still be included in the file, including the opening and closing tags.

    • The following nodes can be removed: ID, Status, Create Date, Modified Date, Helpful Votes, Nonhelpful Votes, Headline, Overall Ratings, Comments, Nickname, Location, and Email Address.

Example XLM file of a product containing reviews:

<?xml version="1.0" encoding="utf-8"?>
<products xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<product xsi:type="ProductWithReviews" locale="en_US">
<pageid>SX4273-001-NIKE</pageid>
<name/>
<smallstarimagelocation>pwr/engine/images/stars_small.gif</smallstarimagelocation>
<largestarimagelocation>pwr/engine/images/stars.gif</largestarimagelocation>
<newestreviewdate>2012-10-23</newestreviewdate>
<oldestreviewdate>2012-10-23</oldestreviewdate>
<averageoverallrating>4</averageoverallrating>
<average_rating_decimal>4</average_rating_decimal>
<fullreviews>2</fullreviews>
<confirmstatusgroup>
<confirmstatus>Unverified</confirmstatus>
</confirmstatusgroup>
<bottom_line_yes_votes>0</bottom_line_yes_votes>
<bottom_line_no_votes>0</bottom_line_no_votes>
<customerimages>false</customerimages>
<customervideos>false</customervideos>
<inlinefiles>
<inlinefile reviewpage="1">pwr/x59spj22/inline/05/44/SX4273__001__NIKE-en_US-1-reviews.html</inlinefile>
</inlinefiles>
<reviews>
<fullreview>
<id>36187833</id>
<merchant_review_id>29449789</merchant_review_id>
<merchantuserid/>
<status>Approved</status>
<createddate>2012-10-23</createddate>
<modified_date>2013-01-14</modified_date>
<helpfulvotes>0</helpfulvotes>
<nothelpfulvotes>0</nothelpfulvotes>
<source>web</source>
<confirmstatusgroup>
<confirmstatus>Unverified</confirmstatus>
</confirmstatusgroup>
<headline>checking this product feature</headline>
<overallrating>3</overallrating>
<comments>cheking this product featurecheking this product feature</comments>
<nickname>test</nickname>
<location>newyork</location>
<email_address_from_user>jdoe@gmail.com</email_address_from_user>
<site_id>1</site_id>
</fullreview>
</reviews>
</product>
</products>

Example of an XML file for a product that does not contain a review.

<?xml version="1.0" encoding="utf-8"?>
<products xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<product xsi:type="ProductWithReviews" locale="en_US">
<pageid>SX4273-001-NIKE</pageid>
<name/>
<smallstarimagelocation>pwr/engine/images/stars_small.gif</smallstarimagelocation>
<largestarimagelocation>pwr/engine/images/stars.gif</largestarimagelocation>
<newestreviewdate>2012-10-23</newestreviewdate>
<oldestreviewdate>2012-10-23</oldestreviewdate>
<averageoverallrating>4</averageoverallrating>
<average_rating_decimal>4</average_rating_decimal >
<fullreviews>2</fullreviews >
<confirmstatusgroup>
<confirmstatus>Unverified</confirmstatus>
</confirmstatusgroup>
<bottom_line_yes_votes>0</bottom_line_yes_votes>
<bottom_line_no_votes>0</bottom_line_no_votes>
<customerimages>false</customerimages>
<customervideos>false</customervideos>
<inlinefiles>
<inlinefile reviewpage="1">pwr/x59spj22/inline/05/44/SX4273__001__NIKE-en_US-1-reviews.html</inlinefile>
</inlinefiles>
<reviews>
</reviews>
</product>
</products>

Field Details

In the table below, learn what fields are used in your XML file. Optional data values are nodes that are required, but the values may be left blank. For example, if a review has not been modified the value can be left blank.

Node Name

Description

Data Value Required?

pageid

SKU or Product ID (if SKU is not available). If using Product ID it must match the reviewProductID in the product information.

Yes

average_rating_decimal

Average rating of the reviews

Yes

fullreviews

Number of reviews of the product

Yes

fullreview

The information about the product review. One full review block should be provided per customer review

Optional when reviews exist

fullreview > id

Internal ID of the review

Optional when reviews exist

fullreview > status

Status of the review. All values excepted. Any value than "Approved" will be recorded as "Unapproved" in Listrak

Optional when reviews exist

fullreview > createdate

Date the review was posted

Optional when reviews exist

fullreview > modified_date

Date the review was edited

Optional when reviews exist

fullreview > helpfulvotes

The number of positive reviews

Optional when reviews exist

fullreview > nothelpfulvotes

The number of negative reviews

Optional when reviews exist

fullreview > headline

The title of the review

Optional when reviews exist

fullreview > overallrating

Rating given by the reviewer

Optional when reviews exist

fullreview > comments

Review text

Optional when reviews exist

fullreview > nickname

Name of the reviewer

Optional when reviews exist

fullreview > location

Location where the reviewer is based

Optional when reviews exist

fullreview > email_address_from_user

Email address of the reviewer

Optional when reviews exist

Next Steps

After you've completed the applicable steps explained above, please coordinate with your Project Manager to complete the validation process.

Did this answer your question?