This article lists all Entersaleremotely API parameters, gives a brief description of each and identifies which parameters are required.

The URL is appended with a number of parameters, some of which are always required and others that are optional. A full list is shown in the table below, the links providing more detailed parameter information. Note that the parameters are case-sensitive.

Parameter nameDescriptionRequired/Optional
merchantidentifier
The merchant’s unique Feefo identifier.Required
apikey
A randomly generated alpha numeric value used for authenticating a merchant’s Feefo account.Required
description
The description of the item purchased.Required
productsearchcode
The product identifier.Required
parentsearchcode
The product's parent identifier.Optional
gtinThe product’s Global Trade Item Number (GTIN)
Required (if assigned)
mpnThe product’s Manufacturer Part Number (MPN)
Optional (not needed if gtin supplied)
email
The customer's email address.Required
name
The customer's name.Optional but recommended
orderref
The merchant’s order reference number.Parameter is required, value is optional but recommended
date
The date of the sale.Optional but recommended
tags
Used for filtering data by sales or product attributes for further analysis.Optional
locale
The language of the emails that are sent to the customer.Optional
customerref
The merchant’s customer reference number.Optional
feedbackdateA specific date on which the feedback for this order should be sent out.Optional
productlink
The URL to the product page for the product.Optional
currency
Currency for the amount.Optional
amount
The price paid for the item purchased.Optional
productattributes
Product qualities requiring targeted feedback through separate feedback form questions.Optional
Entersaleremotely API IntroductionEntersaleremotely API: merchantidentifier