Feeds
Product Feed #
Create an XML product feed
If you want to share your products with One2Five, we recommend sharing them in XML format. The example below demonstrates the general structure for XML product feed.
<?xml version="1.0" encoding="UTF-8"?> <Feed name="MarketCode" extractDate="2024-10-16T00:53:00.000000" > <Brands> <Brand>...</Brand> ... </Brands> <Categories> <Category>...</Category> ... </Categories> <Products> <Product>...</Product>
... </Products> </Feed>
Steps to Create XML Feed
each product in the feed should include the following mandatory tag :
- Brand
- Categories
- Products
You need to use the correct elements and attributes to describe the feed, brand, category, and product information. Please refer to the following tables for the child elements and attributes for the <Feed>, <Brands>, <Categories> and <Products> elements.
Feed Element
This element is required. The following table identifies required attributes for the <Feed> element.
| Attribute | Description |
| name | The short version of client name . |
| extractDate | A timestamp that should be in format e.g 2024-07-10T12:28:25.000000 |
Example
<Feed name="ExampleClient" extractDate="2016-01-18T12:00:00">Brands element
| Element | Value | Required |
| Brand | Represents a product brand in your feed, it must contain the following <ExternalId> and <Name> or <Names> child elements. | Yes |
| ExternalId | Unique brand ID that can contain only alphanumeric characters, hyphens (-), and underscores ( _ ). | Yes |
| Name | Name of brand. | Yes |
<Brands> <Brand> <ExternalId>Brand-external_id</ExternalId> <Name>Brand name</Name> </Brand> </Brands>
Categories Element
The <Categories> element specifies each category represented by products in your feed using the child elements listed below. It can also define a category hierarchy. This element is mandatory.
| Element | Value | Required |
|---|---|---|
| Category | Represents a product category in your feed and may include other elements listed in this table. You can include the removed="true" attribute in the <Category> element to mark the category as inactive. | Yes |
| ExternalId | Unique category or subcategory ID that can contain only alphanumeric characters, hyphens (-), and underscores (_). If a category ID contains an invalid character, replace it with an alternate character, such as an underscore. This format is used in the data feed only and does not affect end users. The ID is case insensitive, so you cannot use IDs that match except for case. Ensure that the category ID is stable and will not change, even if the name of the category changes. | Yes |
| Name | Name of the category or subcategory, which is visible to end users. If specifying localized categories in a multilingual implementation, include a <Name> element for each locale in a parent <Names> element, and then specify the locale attribute (of type String) for each <Name> child element | Yes |
| CategoryPageUrl | Unique URL for the category or subcategory. When specifying a URL, be aware of the following: • Do not include extraneous query string parameters that you might use for tracking and partnership codes. • If the URL contains a reserved (special) character, you must URL-encode the character. For example, use & for an ampersand, %20 for a space, or %5B and %5D for square brackets ( [ ]).• If specifying localized categories in a multilingual implementation, include a <CategoryPageUrl> element for each locale in a parent <CategoryPageUrls> element, and then specify the locale attribute (of type String) for each <CategoryPageUrl> child element. | Yes |
Example
<Categories> <Category> <ExternalId>1010</ExternalId> <Name>First Category</Name> <!-- Default category page URL --> <CategoryPageUrl> http://www.example.com/category.htm?cat=1010 </CategoryPageUrl> </Category> <Category> <ExternalId>1010</ExternalId> <Name>First Category</Name> <!-- Default category page URL --> <CategoryPageUrl> http://www.example.com/category.htm?cat=1010 </CategoryPageUrl> </Category> </Categories>
Products Element
The <Products> element defines each product in your feed using the child elements listed below. This element is mandatory. For a complete list of available elements, refer to the product feed schema.
| Element | Value | Required |
|---|---|---|
| Product | Represents a product in your feed and may include other elements listed in this table. You can include the removed="true" attribute in the <Product> element to mark the product as inactive. If the product does not exist in the database and is marked inactive, it will not be added to the database. | Yes |
| ExternalId | Unique product ID that can contain only alphanumeric characters, hyphens (-), and underscores (_). If the external product ID contains an invalid character, replace it with an alternate character, such as an underscore. This ID is case-insensitive and is not visible to end users. | Yes, one for each product |
| Name | The name or names of the product visible to end users. | Yes, one for each locale |
| Description | The product description. One2Five recommends that product descriptions be at least three sentences or 300 characters long. | Yes, one for each locale |
| Brand | The name of the brand to which the product belongs. You must include a <Name> child element to specify the brand name. Note: Specify either <Brand> or <BrandExternalId> in the <Product> element, but do not specify both. | Yes, one per product if <BrandExternalId> is not provided |
| BrandExternalId | The ID of the brand to which the product belongs. Specify this element if a brand is declared as a separate element in the <Brands> block. The value of <BrandExternalId> must match a brand ID defined in the <Brands> block. If the <Brands> block is not defined in the product feed, use <Brand> instead. | Yes |
| CategoryExternalId | Specify this element if a category is declared as a separate element in the <Categories> block. The value of <CategoryExternalId> must match a category ID defined in the <Categories> block. | Yes |
| ProductPageUrl | A unique, uncorrupted URL for a product page. | Yes |
| ImageUrl | A unique URL for the product image. The optimal display size is 600 x 600 pixels. If the URL contains a reserved character, URL-encode the character. | Yes |
| ManufacturerPartNumbers | Manufacturer-specific part number. Specify a <ManufacturerPartNumber> child element for each part number you want to define. Part numbers can contain letters, numerals, and characters. | Yes |
| EANs | European Article Numbers (EANs) used worldwide for marking retail goods. Specify an <EAN> child element for each EAN you want to define, which must be a string of eight numerals or 13 numerals (no letters or other characters allowed). Remove spaces and hyphens because they disrupt syndication matching. | No |
| Attributes | Custom attributes that enable you to define additional product-specific information, to report on product-specific information or to support product families. Specify an <Attribute> child element for each product attribute you want to define. Be sure to include the name of the product attribute using the id attribute of the <Attribute> element; spaces are not permitted in the attribute ID. | Yes |
Example
<Products> <Product> <ExternalId>11111111111abc</ExternalId> <Name>First Product Round with Green</Name> <Description>First Product Description Text</Description> <CategoryExternalId>CategoryExternalId</CategoryExternalId> <ProductPageUrl> http://www.example.com/product.htm?prod=2000001 </ProductPageUrl> <BrandExternalId>BrandExternalId</BrandExternalId> <ImageUrl> http://images.example.com/prodimages/2000001.gif </ImageUrl> <!-- Product details needed for syndication --> <ManufacturerPartNumbers> <ManufacturerPartNumber>26-12345-8Z</ManufacturerPartNumber> </ManufacturerPartNumbers> <EANs> <EAN>0188173724031</EAN> </EANs> <!-- Custom product attributes --> <Attributes> <Attribute id="StarProduct"> <Value>L</Value> </Attribute> </Attributes> </Product> </Products>
Client Review Feed #
To import ratings, reviews, questions, and answers collected before implementing One2Five Ratings & Reviews on your website, you can upload a native content import feed to One2Five. This feed is an XML document detailing the products and user-generated content (UGC) collected by your in-house solution or a third-party provider. If you cannot create an import feed in the required format, One2Five may offer a data conversion service for a fee.
One2Five first imports the feed into your staging environment to ensure proper display. Once you approve the content in staging, One2Five transfers the content to production. This process may take up to two weeks to complete.
Below are examples illustrating the general structure of a simplified native content import feed:
<Feed name="ExampleClient" extractDate="2024-10-13T08:19:50.675483780Z"> <Product disabled="false" removed="false" id="L87695WD2"> <Reviews></Reviews> <ImageUrl>Product Image Url</ImageUrl> <Name>Product Ext Id</Name> <ExternalId>Product Ext Id</ExternalId> <Description>Product Description</Description> <Brand disabled="false"></Brand> <Source>Source Tag</Source> <ProductPageUrl>Product Page Url</ProductPageUrl> <NativeReviewStatistics></NativeReviewStatistics> <NumAnswers>0</NumAnswers> <NumNativeAnswers>0</NumNativeAnswers> <NumNativeQuestions>0</NumNativeQuestions> <NumReviews>1</NumReviews> <NumQuestions>0</NumQuestions> <NumStories>0</NumStories> <ReviewStatistics></ReviewStatistics> <CategoryItems></CategoryItems> <EANs></EANs> <ManufacturerPartNumbers></ManufacturerPartNumbers> </Product> </Feed>
Create Review Feed
Before you display the content on your website, you need to create a review feed file and share it with One2Five to import this content.
before sharing this content make sure that you exclude the reviews with zero ratings as it will negatively impact the overall average rating of the product.
- Ensure the first line of the feed as given below:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>- if you do not have any values for the field you can skip the field itself, don’t include a field with empty values.
- You must use the specific elements and attributes to describe products and information. Refer to the following tables for child elements and attributes for the <Feed>, <Product>, <Reviews> and <ReviewStatistics> elements.
Feed element
The following table identifies the required attributes for the <Feed> element.
| Attribute | Description | Required |
| name | The short version of Client | Yes |
| extractDate | A timestamp eg format “2024-07-10T07:42:41.118Z” | Yes |
<Feed name="client_name" extractDate="2024-07-10T07:42:41.118Z">Product element
The <Product> element specifies a product in your feed and may be included <Reviews> as child elements. You can add multiple <Product> elements to your feed, each representing a different product.
This element should have the following:
- id attribute—Its value must match the product’s ExternalId value in Product Feed
- <ExternalId> child element—Its value must match the id attribute’s value.
| Element | Value | Required |
| CategoryId | “Category ID” is a unique identifier assigned to a specific category of products, allowing the platform to organize and classify reviews and other user-generated content according to product types or categories | Yes |
| ProductId | The Product ID links all user-generated content (reviews, images, etc.) to a specific product, ensuring that only relevant information is displayed on the correct product page. | Yes |
| ExternalId | ExternalId (also called an “External Product ID”) is a unique identifier assigned by the brand or retailer to represent a specific product within their own catalog or system. | Yes |
| Reviews | Reviews are pieces of user-generated content (UGC) where customers share their experiences, opinions, and feedback about a product. | Yes |
| ImageUrl | A unique URL for the product image. The optimal display size is 600 x 600 pixels. If the URL contains a reserved character, URL-encode the character. | Optional |
| ManufacturerPartNumbers | Manufacturer-specific part number. Specify a <ManufacturerPartNumber> child element for each part number you want to define. Part numbers can contain letters, numerals, and characters. | Optional |
| EANs | European Article Numbers (EANs) used worldwide for marking retail goods. Specify an <EAN> child element for each EAN you want to define, which must be a string of eight numerals or 13 numerals (no letters or other characters allowed). Remove spaces and hyphens because they disrupt syndication matching. | Optional |
| Name | The name or names of the product visible to end users. | Optional |
| ExternalId | Unique product ID that can contain only alphanumeric characters, hyphens (-), and underscores (_). If the external product ID contains an invalid character, replace it with an alternate character, such as an underscore. This ID is case-insensitive and is not visible to end users. | Optional |
| Description | The product description. One2Five recommends that product descriptions be at least three sentences or 300 characters long. | Optional |
| Brand | The name of the brand to which the product belongs. You must include a <Name> child element to specify the brand name. Note: Specify either <Brand> or <BrandExternalId> in the <Product> element, but do not specify both. | Optional |
| Source | Source field in a client review feed provides metadata about the origin or method of collection for each review | Optional |
| ProductPageUrl | A unique, uncorrupted URL for a product page. | Optional |
| NativeReviewStatistics | NativeReviewStatistics in the client review feed serves several important purposes, all aimed at providing brands and retailers with valuable insights and metrics regarding the reviews submitted directly on their platforms | Optional |
| NumAnswers | Contains number of total Answers | Optional |
| NumNativeAnswers | NumNativeAnswers refers to the total number of answers provided to customer questions associated with a specific product or review. | Optional |
| NumReviews | Contains the number of total Reviews | Optional |
| ReviewStatistics | ReviewStatistics component of the client review feed provides a summary of key metrics related to customer reviews for a specific product. | Optional |
| CategoryItems | CategoryItems in the review client feed refers to the specific categories or classifications associated with a product. | Optional |
Example
<Product disabled="false" removed="false" id="L87695WD2"> <Reviews></Reviews> <ImageUrl>Product Image Url</ImageUrl> <Name>Product Ext Id</Name> <ExternalId>Product Ext Id</ExternalId> <Description>Product Description</Description> <Brand disabled="false"></Brand> <Source>Source Tag</Source> <ProductPageUrl>Product Page Url</ProductPageUrl> <NativeReviewStatistics></NativeReviewStatistics> <NumAnswers>0</NumAnswers> <NumNativeAnswers>0</NumNativeAnswers> <NumNativeQuestions>0</NumNativeQuestions> <NumReviews>1</NumReviews> <NumQuestions>0</NumQuestions> <NumStories>0</NumStories> <ReviewStatistics></ReviewStatistics> <CategoryItems></CategoryItems> <EANs></EANs> <ManufacturerPartNumbers></ManufacturerPartNumbers> </Product>
Reviews and Review elements
This element includes <Review> child elements, each representing a piece of content you want to import and display alongside your product. Each <Review> element must include a unique id attribute (integer). Then, specify child elements within each <Review> element. The following table lists the most common elements.
| Element | Value | Required |
| ReviewId | The Review ID uniquely identifies each customer review for a product. | Yes |
| ModerationStatus | This has information about the moderated status of the review, values are APPROVED or REJECTED. | Yes |
| UserProfileReference | This element contains information about the profile. The following child elements should be present for each <UserProfileReference> element. 1) <ExternalId> Identifier of the user. The user ID cannot include spaces or special characters, and it should never include an email address or other personally identifiable information (PII), unless it is hashed to obfuscate the data. This element is required. 2) <DisplayName> Name of the reviewer that is displayed with their content. Must be unique across all users specified in the feed, unless duplicate nicknames are allowed. This element is required if an existing client wants to import content 3) <Anonymous> Whether the user wants to stay anonymous. If set to true, most of the information and fields are not seen. This element is required. 4) <HyperlinkingEnabled> Indicates if a user’s answers are automatically parsed for hyperlinks. Set this to false if you are unsure. This element is required. | Yes |
| CampaignId | Represents the ID of the campaign associated with the review. | No |
| ContentCodes | Holds any content codes related to the review. | No |
| DisplayLocale | Locale from which the review was submitted. This element is required if you are importing content from different locales or languages. | Optional |
| FirstPublishTime | The timestamp of when the review was first published. | Optional |
| LastModificationTime | The timestamp of the last modification made to the review. | Optional |
| LastPublishTime | The timestamp of the last time the review was published. | Optional |
| NetPromoterComment | A comment related to the Net Promoter Score (NPS) feedback. | Optional |
| NetPromoterScore | The score given by the user for NPS. | Optional |
| NumComments | The number of comments associated with the review. | Optional |
| OriginatingDisplayCode | The display code from which the review originated. | Optional |
| ProductReviewsDeepLinkedUrl | A deep link URL to the product reviews. | Optional |
| ProductReviewsUrl | The URL linking to product reviews. | Optional |
| Rating | A rating value chosen by the reviewer (usually this is a reflection of the number of “stars”). | Yes |
| RatingRange | The maximum rating possible (e.g., 5). | Optional |
| RatingsOnly | Indicates if the review consists of ratings only (true/false). | Optional |
| Recommended | Whether review is marked with the “Recommended” flag. This means that during review submission, the user confirmed that they will recommend this product to a friend. | Optional |
| ReviewerLocation | The location of the reviewer. | Optional |
| ReviewerNickname | The nickname of the reviewer. | Optional |
| SendEmailAlertWhenCommented | Indicates if an email alert should be sent when commented on (true/false). | Optional |
| SendEmailAlertWhenCommentedOptOutURL | URL to opt out of email alerts when commented on. | Optional |
| SendEmailAlertWhenPublished | Indicates if an email alert should be sent when published (true/false). | Optional |
| Title | Review title in a form specified by its author. | Yes |
| ReviewText | Full text of the review in a form specified by its author. | Yes |
| UserEmailAddress | The user’s email address. This element is optional, but it is a best practice to include it. | Optional |
| SubmissionTime | The time when the review was submitted by its author | Yes |
| Featured | Whether this content is especially interesting and well written. This value is assigned during moderation. This element is required. | Optional |
| NumFeedbacks | Number of any feedback entries on a given review (positive + negative). | Optional |
| NumPositiveFeedbacks | Number of positive feedback entries on a given review. | Optional |
| NumNegativeFeedbacks | Number of negative feedback entries on a given review. | Optional |
| NumInappropriateFeedbacks | Number of times customers reported that this review has inappropriate or irrelevant content. | Optional |
| AdditionalFields and AdditionalField | Each <AdditionalField> element must specify the id attribute and its value. Then, for each <AdditionalField> element, specify these child elements: <DisplayLabel> <Value> | Optional |
| RatingValues and RatingValue | A list of secondary ratings for different dimensions or product qualities. Specify this element and its child elements if you want to display an additional (secondary) rating for a product. For each <RatingValue> element, specify these child elements: <Rating> A score chosen by the user for a specific dimension. This is required. Type: Int (int(11)) <RatingDimension>Specifies information about alternative characteristics, such as the ease of use, price, material, or comfort. This is required. The following attributes are required for this element: displayType, which indicates the type of tool used to provide the rating value, such as NORMAL, SLIDER, or RADIO. id, which must match the <ExternalId>. selectedValueInDisplayEnabled, which indicates whether the value should be shown in display or hidden. Then, specify these child elements: <ExternalId>, which is the ID of the value that was rated. <Label>, which is the customer-facing label of value that was rated. <RatingRange>, which indicates the maximum value of a secondary rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) “maximum stars” for their secondary ratings functionality. This value is configured in the client’s display or submission configuration. | Optional |
| ClientResponses and ClientResponse | A list of client responses from a representative of your company for a consumer comment left on a product. Each <ClientResponse> element should include the following child elements: <Department>: Identification or location of the physical or online store from which the response is originating. This is recommended if the department of the responding party is available. Type: String (varchar(255)) <Name>: The name of the person who left a comment from the client’s side. This is recommended if the name of the responding party is available. Type: String (varchar(255)) <Response>: The text of the response. This field is required. Type: String (text) <ResponseSource>: The source from which the response was submitted. This is recommended. Type: String (varchar(255)) <Date>: The date of submission. Responses and client comments are not moderated. Type: String (varchar(255)) | Optional |
| Tags and TagDimension | A list of tag dimensions. Specify this element and its child elements if you want to display product tags. Each <TagDimension> element must include the id attribute, and its value must match the value of the <ExternalId> child element. The value is that of QuestionID, which you noted in “Set up additional ratings, submission form questions, and tags.” For each <TagDimension> element, specify these child elements:<ExternalId>: Identifier of the tag dimension. Type: String (varchar(255)) <Label>: The client-facing label for the tag dimension. The value is taken from a client or default display configurations (if any description is available). This is required. Type: String (varchar(255)) <Tags> and <Tag>: A list of tags. For each <Tag> child element, you must specify the <Label> child element, which explains a tag in the tag dimension. The value is taken from a client or default display configurations (if any description is available). This is required. Type: String (varchar(255)) | Optional |
| Photos and Photo | A set of photo references with captions left by the reviewer. Each <Photo> child element must specify the id attribute, and its value must be unique. For each <Photo> element, specify these child elements:<Caption>: A description of the photo left by the reviewer. Type: String (text) <Sizes> and <Size>: A list of images in different sizes (if available). Each <Size> child element must include these attributes: id: Specifies the ID of the size.url: Specifies a URL to an image of a certain size. If the URL contains a reserved (special) character, you must URL-encode the character. For example, use & for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([]).<Sizes> and <Size> are required. | Optional |
| Videos | Contains video attachments associated with the review. | Optional |
| Documents | Contains documents attached to the review. | Optional |
| Badges | Represents any badges earned by the reviewer (e.g., Verified Purchaser). | Optional |
| AuthenticationType | Specifies the type of authentication used for the review submission (e.g., EMAIL). | Optional |
| SyndicationSource | The source from which the review was syndicated. | Optional |
| Comments | Any comments associated with the review. | Optional |
| ContextDataValues and ContextDataValue | A list of dropdown questions that may be included in a review. Specify this element and its child elements if you wish to display information collected via a dropdown question for a product or user. Each <ContextDataValue> child element must include the id attribute, and its value should correspond to the QuestionID noted in “Set up additional ratings, submission form questions, and tags.” For each <ContextDataValue> element, specify these child elements:<ContextDataDimension>: A description of what was evaluated. This element must include the id attribute, representing the dimension’s label. This is required.Then, specify these child elements: <ExternalId>: Matches the value of the id attribute.Type: String (varchar(255)) <Label>: The customer-facing label of the dimension. Type: String (varchar(255)) <ExternalId>: The value chosen by a user (reviewer). Type: String (varchar(255)) <Label>: The customer-facing label that is displayed. This is required. Type: String (varchar(255)) | Optional |
Example
<Reviews> <Review id="review_id"> <UserProfileReference id="profile_ext_id"> <Anonymous>true</Anonymous> <DisplayName>display_name</DisplayName> <ExternalId>profile_ext_id</ExternalId> <HyperLinkingEnabled>false</HyperLinkingEnabled> </UserProfileReference> <CampaignId></CampaignId></CampaignId> <ContentCodes></ContentCodes></ContentCodes> <DisplayLocale>DisplayLocale</DisplayLocale> <UserEmailAddress></UserEmailAddress></UserEmailAddress> <Featured>false</Featured> <FirstPublishTime>2018-09-18T02:14:25.529Z</FirstPublishTime> <LastModificationTime></LastModificationTime></LastModificationTime> <LastPublishTime>2024-10-11T06:02:57.177Z</LastPublishTime> <ModerationStatus>Approved</ModerationStatus> <NetPromoterComment></NetPromoterComment></NetPromoterComment> <NetPromoterScore>0</NetPromoterScore> <NumComments>0</NumComments> <NumFeedBacks>7</NumFeedBacks> <NumNegativeFeedbacks>0</NumNegativeFeedbacks> <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks> <NumPositiveFeedbacks>7</NumPositiveFeedbacks> <OriginatingDisplayCode>OriginatingDisplayCode</OriginatingDisplayCode> <ProductReviewsDeepLinkedUrl></ProductReviewsDeepLinkedUrl></ProductReviewsDeepLinkedUrl> <ProductReviewsUrl></ProductReviewsUrl></ProductReviewsUrl> <Rating>5</Rating> <RatingRange>5</RatingRange> <RatingsOnly>false</RatingsOnly> <Recommended>true</Recommended> <ReviewText>ReviewText</ReviewText> <ReviewerLocation></ReviewerLocation> <ReviewerNickname>ReviewerNickname</ReviewerNickname> <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented> <SendEmailAlertWhenCommentedOptOutURL></SendEmailAlertWhenCommentedOptOutURL> <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished> <SubmissionTime>2018-09-16T16:32:21.256Z</SubmissionTime> <Title>Review Title</Title> <ContextDataValues> <ContextDataValue id="6months"> <ContextDataDimension id="LengthOfOwnership"> <ExternalId>LengthOfOwnership</ExternalId> <Label>Besitzdauer</Label> </ContextDataDimension> <ExternalId>6months</ExternalId> <Label>6 Monate</Label> </ContextDataValue> <ContextDataValue id="Male"> <ContextDataDimension id="Gender"> <ExternalId>Gender</ExternalId> <Label>Geschlecht</Label> </ContextDataDimension> <ExternalId>Male</ExternalId> <Label>Männlich</Label> </ContextDataValue> </ContextDataValues> <RatingValues> <RatingValue> <Rating>3</Rating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Design"> <ExternalId>Design</ExternalId> <Label>Design</Label> <Label1>Design</Label1> <RatingRange>5</RatingRange> </RatingDimension> </RatingValue> <RatingValue> <Rating>3</Rating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Quality"> <ExternalId>Quality</ExternalId> <Label>Quality</Label> <Label1>Quality</Label1> <RatingRange>5</RatingRange> </RatingDimension> </RatingValue> <RatingValue> <Rating>3</Rating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Features"> <ExternalId>Features</ExternalId> <Label>Features</Label> <Label1>Features</Label1> <RatingRange>5</RatingRange> </RatingDimension> </RatingValue> </RatingValues> <Videos> <Video> <Caption></Caption> <VideoUrl>https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/videos/1682657592125_WMV_Video.wmv</VideoUrl> </Video> </Videos> <Badges> <Badge> <Name>VerifiedPurchaser</Name> <ContentType>Review</ContentType> </Badge> <Badge> <Name>IncentivizedReview</Name> <ContentType>Review</ContentType> </Badge> <Badge> <Name>Employee</Name> <ContentType>Review</ContentType> </Badge> <Badge> <Name>SweepstakeReview</Name> <ContentType>Review</ContentType> </Badge> </Badges> <ClientResponses> <ClientResponse> <ResponseMarkup> <PlainText>PlainText</PlainText> </ResponseMarkup> <Date>2020-06-05T13:57:53.000Z</Date> <Department>Department</Department> <Response>Response</Response> <ResponseSource>Review Hub</ResponseSource> <Name>Name</Name> </ClientResponse> </ClientResponses> <AdditionalFields> <AdditionalField id="productid"> <DisplayLabel>productid</DisplayLabel> <Value>914912563</Value> </AdditionalField> <AdditionalField id="IsPIESubmission"> <DisplayLabel>IsPIESubmission</DisplayLabel> <Value>true</Value> </AdditionalField> </AdditionalFields> <Photos> <Photo> <Sizes> <Size id="large" url="https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/photos/large_1682655617971_Elextrolux_largelogo.png"/> <Size id="thumbnail" url="https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/photos/thumbnail_1682655621282_18788.png"/> <Size id="normal" url="https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/photos/normal_1682655621289_18788.png"/> </Sizes> </Photo> </Photos> <AuthenticationType>EMAIL</AuthenticationType> <SyndicationSource> <ClientId></ClientId> <LogoImageUrl>LogoImageUrl</LogoImageUrl> <ContentLink></ContentLink> <Name>Name</Name> </SyndicationSource> <Comments> <Comment id="228708"> <UserProfileReference id="920269"> <Anonymous>true</Anonymous> <DisplayName>DisplayName</DisplayName> <ExternalId>ExternalId</ExternalId> <HyperLinkingEnabled>false</HyperLinkingEnabled> </UserProfileReference> <DisplayLocale>DisplayLocale</DisplayLocale> <LastModificationTime>2019-10-21T08:22:44.000+00:00</LastModificationTime> <ModerationStatus>APPROVED</ModerationStatus> <SubmissionTime>2015-01-09T04:29:31.000+00:00</SubmissionTime> <CommentText>CommentText</CommentText> <Badges/> <Photos/> <Videos/> <Documents/> </Comment> </Comments> <Documents> <Document id="10283"> <DocumentUrl>https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/documents/1680237622170_sample.pdf</DocumentUrl> <Caption>test document attachment for answer 5</Caption> </Document> </Documents> </Review> </Reviews>
Full Feed Example
<?xml version="1.0" encoding="UTF-8"?> <Feed name="ExampleClient" extractDate="2016-02-12T05:17:33.945-06:00"> <Product id="1010"> <Reviews> <Review id="review_id"> <UserProfileReference id="profile_ext_id"> <Anonymous>true</Anonymous> <DisplayName>display_name</DisplayName> <ExternalId>profile_ext_id</ExternalId> <HyperLinkingEnabled>false</HyperLinkingEnabled> </UserProfileReference> <CampaignId></CampaignId></CampaignId> <ContentCodes></ContentCodes></ContentCodes> <DisplayLocale>DisplayLocale</DisplayLocale> <UserEmailAddress></UserEmailAddress></UserEmailAddress> <Featured>false</Featured> <FirstPublishTime>2018-09-18T02:14:25.529Z</FirstPublishTime> <LastModificationTime></LastModificationTime></LastModificationTime> <LastPublishTime>2024-10-11T06:02:57.177Z</LastPublishTime> <ModerationStatus>Approved</ModerationStatus> <NetPromoterComment></NetPromoterComment></NetPromoterComment> <NetPromoterScore>0</NetPromoterScore> <NumComments>0</NumComments> <NumFeedBacks>7</NumFeedBacks> <NumNegativeFeedbacks>0</NumNegativeFeedbacks> <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks> <NumPositiveFeedbacks>7</NumPositiveFeedbacks> <OriginatingDisplayCode>OriginatingDisplayCode</OriginatingDisplayCode> <ProductReviewsDeepLinkedUrl></ProductReviewsDeepLinkedUrl></ProductReviewsDeepLinkedUrl> <ProductReviewsUrl></ProductReviewsUrl></ProductReviewsUrl> <Rating>5</Rating> <RatingRange>5</RatingRange> <RatingsOnly>false</RatingsOnly> <Recommended>true</Recommended> <ReviewText>ReviewText</ReviewText> <ReviewerLocation></ReviewerLocation> <ReviewerNickname>ReviewerNickname</ReviewerNickname> <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented> <SendEmailAlertWhenCommentedOptOutURL></SendEmailAlertWhenCommentedOptOutURL> <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished> <SubmissionTime>2018-09-16T16:32:21.256Z</SubmissionTime> <Title>Review Title</Title> <ContextDataValues> <ContextDataValue id="6months"> <ContextDataDimension id="LengthOfOwnership"> <ExternalId>LengthOfOwnership</ExternalId> <Label>Besitzdauer</Label> </ContextDataDimension> <ExternalId>6months</ExternalId> <Label>6 Monate</Label> </ContextDataValue> <ContextDataValue id="Male"> <ContextDataDimension id="Gender"> <ExternalId>Gender</ExternalId> <Label>Geschlecht</Label> </ContextDataDimension> <ExternalId>Male</ExternalId> <Label>Männlich</Label> </ContextDataValue> </ContextDataValues> <RatingValues> <RatingValue> <Rating>3</Rating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Design"> <ExternalId>Design</ExternalId> <Label>Design</Label> <Label1>Design</Label1> <RatingRange>5</RatingRange> </RatingDimension> </RatingValue> <RatingValue> <Rating>3</Rating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Quality"> <ExternalId>Quality</ExternalId> <Label>Quality</Label> <Label1>Quality</Label1> <RatingRange>5</RatingRange> </RatingDimension> </RatingValue> <RatingValue> <Rating>3</Rating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Features"> <ExternalId>Features</ExternalId> <Label>Features</Label> <Label1>Features</Label1> <RatingRange>5</RatingRange> </RatingDimension> </RatingValue> </RatingValues> <Videos> <Video> <Caption></Caption> <VideoUrl>https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/videos/1682657592125_WMV_Video.wmv</VideoUrl> </Video> </Videos> <Badges> <Badge> <Name>VerifiedPurchaser</Name> <ContentType>Review</ContentType> </Badge> <Badge> <Name>IncentivizedReview</Name> <ContentType>Review</ContentType> </Badge> <Badge> <Name>Employee</Name> <ContentType>Review</ContentType> </Badge> <Badge> <Name>SweepstakeReview</Name> <ContentType>Review</ContentType> </Badge> </Badges> <ClientResponses> <ClientResponse> <ResponseMarkup> <PlainText>PlainText</PlainText> </ResponseMarkup> <Date>2020-06-05T13:57:53.000Z</Date> <Department>Department</Department> <Response>Response</Response> <ResponseSource>Review Hub</ResponseSource> <Name>Name</Name> </ClientResponse> </ClientResponses> <AdditionalFields> <AdditionalField id="productid"> <DisplayLabel>productid</DisplayLabel> <Value>914912563</Value> </AdditionalField> <AdditionalField id="IsPIESubmission"> <DisplayLabel>IsPIESubmission</DisplayLabel> <Value>true</Value> </AdditionalField> </AdditionalFields> <Photos> <Photo> <Sizes> <Size id="large" url="https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/photos/large_1682655617971_Elextrolux_largelogo.png"/> <Size id="thumbnail" url="https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/photos/thumbnail_1682655621282_18788.png"/> <Size id="normal" url="https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/photos/normal_1682655621289_18788.png"/> </Sizes> </Photo> </Photos> <AuthenticationType>EMAIL</AuthenticationType> <SyndicationSource> <ClientId></ClientId> <LogoImageUrl>LogoImageUrl</LogoImageUrl> <ContentLink></ContentLink> <Name>Name</Name> </SyndicationSource> <Comments> <Comment id="228708"> <UserProfileReference id="920269"> <Anonymous>true</Anonymous> <DisplayName>DisplayName</DisplayName> <ExternalId>ExternalId</ExternalId> <HyperLinkingEnabled>false</HyperLinkingEnabled> </UserProfileReference> <DisplayLocale>DisplayLocale</DisplayLocale> <LastModificationTime>2019-10-21T08:22:44.000+00:00</LastModificationTime> <ModerationStatus>APPROVED</ModerationStatus> <SubmissionTime>2015-01-09T04:29:31.000+00:00</SubmissionTime> <CommentText>CommentText</CommentText> <Badges/> <Photos/> <Videos/> <Documents/> </Comment> </Comments> <Documents> <Document id="10283"> <DocumentUrl>https://s3.eu-central-1.amazonaws.com/one2five-test/attachment/documents/1680237622170_sample.pdf</DocumentUrl> <Caption>test document attachment for answer 5</Caption> </Document> </Documents> </Review> </Reviews> </Product> <ImageUrl>Product Image Url</ImageUrl> <Name>EW6F38EU</Name> <ExternalId>EW6F38EU</ExternalId> <Description>EW6F38EU</Description> <Brand disabled="false"> <ExternalId>ExternalId</ExternalId> <Name>Name</Name> <Attributes> <Attribute id="NAME"> <Value>Value</Value> </Attribute> </Attributes> </Brand> <Source>Source</Source> <ProductPageUrl>ProductPageUrl</ProductPageUrl> <NativeReviewStatistics> <AverageOverallRating>3.6666666666666665</AverageOverallRating> <NotRecommendedCount>0</NotRecommendedCount> <OverallRatingRange>0</OverallRatingRange> <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount> <RecommendedCount>10</RecommendedCount> <TotalReviewCount>10</TotalReviewCount> <clientNativeReviewAverageRatingValues> <AverageRatingValue id="Design"> <AverageRating>3.8</AverageRating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Design"> <ExternalId>Design</ExternalId> <Label>Design</Label> <Label1>Design</Label1> <RatingRange>5</RatingRange> </RatingDimension> </AverageRatingValue> </clientNativeReviewAverageRatingValues> <clientNativeReviewRatingDistribution> <RatingDistributionItem> <RatingValue>3</RatingValue> <Count>2</Count> </RatingDistributionItem> </clientNativeReviewRatingDistribution> </NativeReviewStatistics> <NumAnswers>0</NumAnswers> <NumNativeAnswers>0</NumNativeAnswers> <NumNativeQuestions>0</NumNativeQuestions> <NumReviews>10</NumReviews> <NumQuestions>0</NumQuestions> <NumStories>0</NumStories> <ReviewStatistics> <AverageOverallRating>3.6666666666666665</AverageOverallRating> <NotRecommendedCount>0</NotRecommendedCount> <OverallRatingRange>0</OverallRatingRange> <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount> <RecommendedCount>10</RecommendedCount> <TotalReviewCount>10</TotalReviewCount> <AverageRatingValues> <AverageRatingValue id="Design"> <AverageRating>3.8</AverageRating> <RatingDimension displayType="NORMAL" SelectedValueInDisplayEnabled="false" id="Design"> <ExternalId>Design</ExternalId> <Label>Design</Label> <Label1>Design</Label1> <RatingRange>5</RatingRange> </RatingDimension> </AverageRatingValue> </AverageRatingValues> <RatingDistribution> <RatingDistributionItem> <RatingValue>3</RatingValue> <Count>2</Count> </RatingDistributionItem> </RatingDistribution> </ReviewStatistics> <CategoryItems> <CategoryItem id="Category Item Id"> <ExternalId>ExternalId</ExternalId> <CategoryName>CategoryName</CategoryName> <CategoryId>6327</CategoryId> </CategoryItem> </CategoryItems> <EANs> <EAN>7332543586745</EAN> </EANs> <ManufacturerPartNumbers> <ManufacturerPartNumber>914917233</ManufacturerPartNumber> </ManufacturerPartNumbers> </Feed>
PIE Feed #
Even if you have some automatic review collection systems, the feed-based method can be useful for sending review requests to email addresses so that they can submit the review for the purchased product offline stores.
Pie interactions can be uploaded to the system using a CSV file.
Create a CSV file
The following columns are interaction columns:
- ProductExternalId
- UserNickname
- TimeOfInteraction
- DisplayCode
- CustomerId
The following example shows the general structure of the CSV file
| ProductExternalId | UserNickname | TimeOfInteraction | DisplayCode | CustomerId | |
| M2GCP100 | testuser01elx@gmail.com | testuser01elx | 21.03.2024 04:22:56.445 | xabc-at_it | 199191 |
| M2WCP050 | testuser02elx@gmail.com | testuser02elx | 21.03.2024 04:22:56.445 | abc-ia_gb | 199192 |
| M2GCP1000 | testuser03elx@gmail.com | testuser03elx | 21.03.2024 04:22:56.445 | abc-it_ig | 199193 |
One2five recommend to use following date format:
yyyy-MM-dd HH:mm:ss.SSSDatafield details:
| Field | Description |
| TimeOfInteraction | The purchase, shipping, or other interaction date |
| DisplayCode | market language |
| Customer email address | |
| CustomerId | Customer’s user ID, typically created during an online transaction |
| UserNickname | The customer’s user ID, typically created during an online transaction |
| ProductExternalId | As the field’s name says, it is the username that the user prefers to share. |
Each transaction in the feed represents its own interaction element under the root. Transaction related data is under the element like TransactionDate under respective transaction.
The following example shows the general structure of a simplified XML interaction feed that shows all possible elements:
<Feed> <Interaction> <TransactionDate>2022-01-01T00:00:00</TransactionDate> <EmailAddress>new_email@example.com</EmailAddress> <UserName>New User</UserName> <UserID>0000000</UserID> <Locale>en_US</Locale> <Products> <Product> <ExternalId>NEWID123456</ExternalId> <Name>New Product Name</Name> <Price>999.99</Price> </Product> </Products> </Interaction> <Interaction> <TransactionDate>2022-01-01T00:00:00</TransactionDate> <EmailAddress>new_email@example.com</EmailAddress> <UserName>New User</UserName> <UserID>0000000</UserID> <Locale>en_US</Locale> <Products> <Product> <ExternalId>NEWID123456</ExternalId> <Name>New Product Name</Name> <Price>999.99</Price> </Product> </Products> </Interaction> <Interaction> <TransactionDate>2022-01-01T00:00:00</TransactionDate> <EmailAddress>new_email@example.com</EmailAddress> <UserName>New User</UserName> <UserID>0000000</UserID> <Locale>en_US</Locale> <Products> <Product> <ExternalId>NEWID123456</ExternalId> <Name>New Product Name</Name> <Price>999.99</Price> </Product> </Products> </Interaction> </Feed>
Use the following best practices when you create an interaction data feed file (XML interaction feed).
- Interaction dates must conform to the XML dateTime format, such as: 2021-11-10T17:17:01.000.
- Ensure the first line of your feed adheres to the following format:
<?xml version="1.0" encoding="utf-8"?>. - If you do not have a value for a particular field, omit the field from your feed instead of including it with a blank value.
Review Import #
Review import is a functionality where the review data present in CSV file can be imported to the system, this can be done by creating a file as per the format shared below and share it with One2Five which will be used to import the reviews data in bulk into the system.
| Field | Description | Required |
| SubmissionTime | Review submission date time format for example 2024-01-30 11:03:14 | Yes |
| TermsAndConditions | value should be boolean true or false | Yes |
| Category | optional field, should contain category name data of product | Optional |
| ProductExternalId | Product Id, as per present in product feed. | Yes (if ProductEAN is null) |
| ProductEAN | optional field , must match to product ean in product feed. | Yes (if ProductExternalId is null) |
| UserNickname | user name which the user prefers to share | Yes |
| email of user who has submitted the review | Yes | |
| Rating | rating value | Yes |
| RatingDesign | design rating value | Optional |
| RatingQuality | quality rating value | Optional |
| RatingFunctionality | functionality rating value | Optional |
| ReviewTitle | review title, small title to the review submitted | Yes |
| ReviewText | summary of review | Yes |
| isRecommended | boolean value, contains true or false | Optional |
| CompetitionOptIn | boolean value, contains true or false | Optional |
sample file which can be taken as reference to create review import file can be downloaded from here
Badge Update #
Upload Badges is a functionality by which badges can be imported to the reviews submitted by particular user email for respective products.
For badge upload the EXCEL file contains the following columns.
| Field | Description |
| Verified Reviews | This column contains email id of the the user who submitted the review for which the badge is to be assigned. |
| Device Database | This contains product id of product |
| Device Reviews | This contains product id of product (note : Device Database value and Device Reviews should contain same value to process the badge further or else it will be skipped ) |
| Verified | contains value true or false |
| Incentivized | contains value 1 or 0 |
sample file which can be taken as reference to create review import file can be downloaded from here