This article is a list and description of all parameters that can be added to the Feefo logo URL.

The URL:

https://api.feefo.com/api/logo?

is constructed using several parameters and values, all of which are listed in the following table:

ParameterDescriptionRequired/Optional
merchantidentifier 
The Feefo merchant identifierRequired 
template
The name of the badge template
Required 
accept-language 
Define the badge display languageOptional
tags  
Used to filter the feed by sale or product tags
Optional 
vendorref 
The product search code for product feedback
Optional 
parentvendorrefThe product parent ref for the group of products the badge rating should displayOptional
since 
Used to define the time period over which the badge rating is calculated. 
Optional
smallonzero 
When there are no reviews to show, the badge is not displayed and a single pixel is displayed instead
Optional 
servicedefault 
When there are no product reviews to show, display the service badge and rating instead
Optional 

Further details for each parameter are shown below. Note that all of the parameter names and values are entirely in lower-case letters.

merchantidentifier

Required with no default value.

merchantidentifier is the merchant’s unique Feefo identifier. To find your merchant identifier see Where to find my merchant identifier.

template

Required with no default value.

template is the name of the badge template that’s to be used. The full list of badges can be seen at Feefo Badges or through the interactive badge selector in the Feefo Hub under 'Marketing > Widgets Gallery'. The choice of template determines if the rating for service, product or both service and product are shown. For example, template=Product-Stars-White-150x38.png only displays a product rating.

accept-language

Optional, the default value is the same as the web browser's locale.

accept-language defines the display language of the badge. By default, the language of the badge is set to be the same as the locale of the viewer's web browser, however, accept-language will override this and instead display a defined language version. The languages available are shown in Sales File: locale.

tags

Optional with no default value.

tags is a method of filtering the Feefo logo feed by sales or product tags. Tag key and value pairs are passed in by prefixing the tag ‘key value’ pair with tags in the query string and then providing a value. tags can have one or more valid tags with each ‘key’ and ‘value’ separated using the URL encoded equals symbol of %3D and each ‘key value’ pair separated by a comma. If the key or value consists of more than a single word, the space between the words is replaced with the URL encoded space, %20.

For example:

https://api.feefo.com/api/logo?merchantidentifier=example-retail-merchant&template=Product-Stars-Yellow-Square-200x200.png &tags=country%3DUnited%20Kingdom,category%3DComputers

This example is filtering the returned data for Example Retail Merchant so that only feedbacks for the sales with the tags ‘country=United Kingdom’ AND ‘category=Computers’ are displayed (the equals character is encoded to %3D and the space is encoded to %20). Where several ‘key value’ pairs are listed in the URL call, only those sales or products that have all of the listed ‘key value’ pairs will be selected. A full list of available tags can be found in Sales and Product Tags.

vendorref

Optional with no default value.

vendorref is the product search code or SKU as supplied in the order information sent to Feefo. If a product has many sizes or colours and therefore has different SKUs but with a standard prefix, the wildcard * can be used to calculate a rating based on all feedbacks against that prefix. For example, vendorref=Echineaforce* will return a rating aggregated for the several sizes of Echineaforce tablets available which are listed as Echineaforce-40tabs, Echineaforce-80tabs, Echineaforce-120tabs. vendorref does not support values that include the hash (#) character or the URL ASCII code %23.

parentvendorref

Optional with no default value.

parentvendorref is only possible where the parent product ref has been supplied in the order information sent to Feefo. Instead of displaying a Feefo badge with the rating for a single product, using the parentvendorref instead of vendorref, with a value defined as the parent product ref, a single rating for multiple similar products/variants can be displayed. parentvendorref does not support values that include the hash (#) character or the URL ASCII code %23.

since

Optional, the default value is since=year.

since parameter defines the period over which the badge rating is calculated. By default, the period is a year, however, using since=all will calculate a badge rating that is based on all reviews, irrespective of when it was submitted.

smallonzero

Optional, the default value is smallonzero=false.

smallonzero parameter is only used if no reviews have been recorded for the feed that the service or product badge is calling or if the minimumproductrating or minimumservicerating has not been reached. If not defined within the URL, a blank space the same size and shape as the logo will be displayed. If smallonzero=true, a single pixel will be displayed instead.

servicedefault

Optional, the default value is servicedefault=false.

servicedefault parameter is only used when no reviews have been recorded for the feed that the product badge is calling or if the minimumproductrating has not been reached. If not defined within the URL, a blank space the same size and shape as the logo will be displayed. If servicedefault=true, the service logo and rating will be displayed instead, replacing the undesired product logo and rating.

Link Integration (Light Integration)